From 7d700f32857fef7bc74e27ee4e05fefe0d29fcce Mon Sep 17 00:00:00 2001 From: PhilKunz Date: Tue, 19 Jul 2016 00:36:19 +0200 Subject: [PATCH] improve README --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 13008ff..60207af 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,14 @@ do more with npm 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", + +}); +``` \ No newline at end of file