update to latest standards

This commit is contained in:
2017-05-12 17:56:51 +02:00
parent 7527049fd0
commit a029eeb6c1
12 changed files with 637 additions and 142 deletions

18
docs/index.md Normal file
View File

@ -0,0 +1,18 @@
## Usage
Use TypeScript for best in class instellisense.
qenv works with two files:
* **qenv.yml** - specifies which ENV vars are required.
* **env.yml** - specifies all env vars that are not already set in the current environment.
Now obviously you can set build specific env vars in many CI environments.
So there we do not need an **env.yml** since all ENV vars are in place
However when on another machine you can have a env.yml that will be added to the environment by qenv.
```javascript
import {Qenv} from "qenv";
myQenv = new Qenv("path/to/dir/where/qenv.yml/is/","path/to/dir/where/env.yml/is(");
```