Skip to content

Commit de6ab18

Browse files
author
supernomad
committed
Fixed up the ReadMe
1 parent 26758a4 commit de6ab18

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ An async upload/download node library leveraging express.js, which provides chun
1010

1111
What do we mean by a chunked transfer api? Well, what chunkyjs does is provide an api interface that allows downloading or uploading multiple chunks of a file at the same time. This effectively allows you to multi-thread your applications data transfer logic.
1212

13-
chunkyjs also comes with prebuilt nodejs/iojs and web browser clients that can be used to facilitate access to the api in a front-end environment.
1413
### Installation
1514
Installation is the same as any other module.
1615
```
@@ -27,9 +26,23 @@ Basic usage of chunkyjs is as simple as requiring the module and passing it into
2726
app.listen(8080);
2827
```
2928

29+
### Development/Testing
30+
```
31+
git clone https://github.com/Supernomad/chunky.git
32+
cd chunky/
33+
npm install
34+
npm install -g grunt-cli
35+
grunt
36+
```
37+
3038
### Datastore
3139
chunkyjs is currently employing `node-cache` in order to store transfer specific metadata. This is great for development, however means that chunkyjs in its current state cannot be clustered. Support for clustered datastores is on the way.
3240

41+
### TODO
42+
- Create the front-end client's
43+
- Need to properly handle downloads in a browser context.
44+
- Create the node client's
45+
3346
### Contributing
3447
We welcome contributions, feel free to fork us and make as many PR's as you would like.
3548

0 commit comments

Comments
 (0)