improve README

This commit is contained in:
Philipp Kunz 2016-05-20 01:25:17 +02:00
parent f0efe9adac
commit 80b9040b0d
2 changed files with 34 additions and 0 deletions

12
README.md Normal file
View File

@ -0,0 +1,12 @@
# early
nice module loading animation for modules that need a little starting time.
> **note: this package is NOT READY YET**
```typscript
import * as early from "early";
early.start();
// do your loading stuff
early.stop();
```

22
package.json Normal file
View File

@ -0,0 +1,22 @@
{
"name": "early",
"version": "1.0.0",
"description": "nice module loading animation for modules that need a little starting time.",
"main": "dist/index.js",
"scripts": {
"test": "(npmts)"
},
"repository": {
"type": "git",
"url": "git+https://github.com/pushrocks/early.git"
},
"keywords": [
"preloader"
],
"author": "Lossless GmbH",
"license": "MIT",
"bugs": {
"url": "https://github.com/pushrocks/early/issues"
},
"homepage": "https://github.com/pushrocks/early#readme"
}