improve README

This commit is contained in:
Philipp Kunz 2016-07-19 00:36:19 +02:00
parent 4ee9c46b04
commit 7d700f3285

View File

@ -2,3 +2,14 @@
do more with npm do more with npm
npmextra is a hub for a series of js tools that help writing, documenting and maintaining npm modules. npmextra is a hub for a series of js tools that help writing, documenting and maintaining npm modules.
## Usage
The main purpose of npmextra is to configure different tools using one npmextra.json. This way complex setups avaoid complexity through many configuration files.
```typescript
let npmextra = require("npmextra");
npmextra.dataFor({
toolName:"sometool",
});
```