From 524fc5265f13826298cd9e4f75cb5d3a94429023 Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Mon, 13 Aug 2018 00:45:57 +0200 Subject: [PATCH] fix(docs): update --- README.md | 15 ++++++++++++++- docs/index.md | 18 ------------------ 2 files changed, 14 insertions(+), 19 deletions(-) delete mode 100644 docs/index.md diff --git a/README.md b/README.md index 29168c9..10d13f1 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,20 @@ easy promised environments Use TypeScript for best in class instellisense. -For further information read the linked docs at the top of this README. +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('); +``` > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) > | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 1368db1..0000000 --- a/docs/index.md +++ /dev/null @@ -1,18 +0,0 @@ -## 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('); -```