Compare commits
7 Commits
Author | SHA1 | Date | |
---|---|---|---|
2fa659a22a | |||
bdc99cc3a6 | |||
2956278369 | |||
c61ef2eeba | |||
41c97c4c05 | |||
8870f9adf2 | |||
dfb400ba5c |
18
README.md
18
README.md
@ -2,6 +2,18 @@
|
||||
provides an easy way for promised environments
|
||||
|
||||
## Usage
|
||||
qenv looks for an qenv.yml that defines needed env vars. qenv dirst checks if they are already specified.
|
||||
If not, qenv by default looks for a .nogit/env.yml file.
|
||||
If any env var is not specified, qenv throws an error and exits.
|
||||
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.
|
||||
|
||||
```typescript
|
||||
import {Qenv} from "qenv";
|
||||
|
||||
myQenv = new Qenv("path/to/dir/where/qenv.yml/is/","path/to/dir/where/env.yml/is(");
|
||||
|
||||
```
|
@ -1,8 +1,9 @@
|
||||
{
|
||||
"name": "qenv",
|
||||
"version": "1.0.3",
|
||||
"version": "1.0.6",
|
||||
"description": "promised environments",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
"scripts": {
|
||||
"test": "(npmts)"
|
||||
},
|
||||
|
Reference in New Issue
Block a user