update readme
This commit is contained in:
parent
489ebab6ee
commit
fe2210dc9f
34
README.md
34
README.md
@ -2,14 +2,15 @@
|
||||
store things about your environment and let them travel across modules
|
||||
|
||||
## Availabililty
|
||||
[](https://www.npmjs.com/package/smartenv)
|
||||
[](https://gitlab.com/pushrocks/smartenv)
|
||||
[](https://github.com/pushrocks/smartenv)
|
||||
[](https://pushrocks.gitlab.io/smartenv/)
|
||||
[](https://www.npmjs.com/package/smartenv)
|
||||
[](https://GitLab.com/pushrocks/smartenv)
|
||||
[](https://github.com/pushrocks/smartenv)
|
||||
[](https://pushrocks.gitlab.io/smartenv/)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/smartenv/commits/master)
|
||||
[](https://gitlab.com/pushrocks/smartenv/commits/master)
|
||||
[](https://GitLab.com/pushrocks/smartenv/commits/master)
|
||||
[](https://GitLab.com/pushrocks/smartenv/commits/master)
|
||||
[](https://www.npmjs.com/package/smartenv)
|
||||
[](https://david-dm.org/pushrocks/smartenv)
|
||||
[](https://www.bithound.io/github/pushrocks/smartenv/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/pushrocks/smartenv)
|
||||
@ -17,23 +18,12 @@ store things about your environment and let them travel across modules
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](http://standardjs.com/)
|
||||
|
||||
## Install
|
||||
Install the package through npm
|
||||
|
||||
```
|
||||
npm install smartenv --save
|
||||
```
|
||||
|
||||
## Usage
|
||||
Use TypeScript for best in class instellisense.
|
||||
|
||||
```javascript
|
||||
var smartenv = require("smartenv");
|
||||
For further information read the linked docs at the top of this README.
|
||||
|
||||
smartenv.info(); //prints an output about your current environment and registered objects
|
||||
smartenv.register({akey:"a text"},"somevalue"); // register a new object
|
||||
smartenv.makeGlobal() // make smartenv available from gobal.smartenv
|
||||
smartenv.get("somevalue").akey; // returns "a text"
|
||||
smartenv.items.somevalue.akey; // also returns "a text"
|
||||
```
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
|
||||
[](https://push.rocks)
|
||||
[](https://push.rocks)
|
||||
|
Loading…
x
Reference in New Issue
Block a user