Skip to content

Commit b76eaf9

Browse files
committed
docs: readme updated
1 parent e34d648 commit b76eaf9

File tree

1 file changed

+4
-14
lines changed

1 file changed

+4
-14
lines changed

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ After this is done and `testChunks` enabled, an upload can quickly catch up even
7272
### Resumable
7373
#### Configuration
7474

75-
The object is loaded with a configuation hash:
75+
The object is loaded with a configuration options:
7676

7777
var r = new Resumable({opt1:'val', ...});
7878

@@ -147,6 +147,7 @@ added.
147147
* `.catchAll(event, ...)` Listen to all the events listed above with the same callback function.
148148

149149
### ResumableFile
150+
ResumableFile constructor can be accessed in `Resumable.ResumableFile`.
150151
#### Properties
151152

152153
* `.resumableObj` A back-reference to the parent `Resumable` object.
@@ -183,12 +184,7 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
183184

184185
* All features or bug fixes must be tested by one or more specs.
185186

186-
* With the exceptions listed below, we follow the rules contained in [Google's JavaScript Style Guide](http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml):
187-
188-
* Wrap all code at 100 characters.
189-
190-
* Instead of complex inheritance hierarchies, we prefer simple objects. We use prototypical
191-
inheritance only when absolutely necessary.
187+
* We follow the rules contained in [Google's JavaScript Style Guide](http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml) with an exception we wrap all code at 100 characters.
192188

193189

194190
## Installation Dependencies
@@ -219,17 +215,11 @@ Browsers should be comma separated and case sensitive.
219215

220216
To re-run tests just change any source or test file.
221217

222-
Automated tests is running after every commit at travis-ci, current build status: [![Build Status](https://travis-ci.org/AidasK/resumable.js.png?branch=Next)](https://travis-ci.org/AidasK/resumable.js)
218+
Automated tests is running after every commit at travis-ci, current build status: [![Build Status](https://travis-ci.org/resumable2/resumable.js.png?branch=Next)](https://travis-ci.org/resumable2/resumable.js)
223219

224220
### Running test on sauceLabs
225221

226222
1. Connect to sauce labs https://saucelabs.com/docs/connect
227223
2. `grunt test --sauce-local=true --sauce-username=**** --sauce-access-key=***`
228224

229225
other browsers can be used with `--browsers` flag, available browsers: sl_opera,sl_iphone,sl_safari,sl_ie10,sl_chorme,sl_firefox
230-
231-
## Alternatives
232-
233-
This library is explicitly designed for modern browsers supporting advanced HTML5 file features, and the motivation has been to provide stable and resumable support for large files (allowing uploads of several GB files through HTTP in a predictable fashion).
234-
235-
If your aim is just to support progress indications during upload/uploading multiple files at once, Resumable.js isn't for you. In those cases, [SWFUpload](http://swfupload.org/) and [Plupload](http://plupload.com/) provides the same features with wider browser support.

0 commit comments

Comments
 (0)