improve README
This commit is contained in:
parent
f0efe9adac
commit
80b9040b0d
12
README.md
Normal file
12
README.md
Normal 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
22
package.json
Normal 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"
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user