From 8bc82854306d8e110ce9f8585e0ca519a06324e8 Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Mon, 8 Jun 2020 18:58:55 +0000 Subject: [PATCH] fix(core): update --- package.json | 2 +- readme.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+), 1 deletion(-) create mode 100644 readme.md diff --git a/package.json b/package.json index 0e3b896..5e996e5 100644 --- a/package.json +++ b/package.json @@ -49,4 +49,4 @@ "npmextra.json", "readme.md" ] -} +} \ No newline at end of file diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..d345bb9 --- /dev/null +++ b/readme.md @@ -0,0 +1,54 @@ +# @pushrocks/qenv +easy promised environments + +## Availabililty and Links +* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/qenv) +* [gitlab.com (source)](https://gitlab.com/pushrocks/qenv) +* [github.com (source mirror)](https://github.com/pushrocks/qenv) +* [docs (typedoc)](https://pushrocks.gitlab.io/qenv/) + +## Status for master + +Status Category | Status Badge +-- | -- +GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/qenv/badges/master/pipeline.svg)](https://lossless.cloud) +GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/qenv/badges/master/coverage.svg)](https://lossless.cloud) +npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/qenv)](https://lossless.cloud) +Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/qenv)](https://lossless.cloud) +TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud) +node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) +Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud) +PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/qenv)](https://lossless.cloud) +PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/qenv)](https://lossless.cloud) +BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/qenv)](https://lossless.cloud) +Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud) + +## 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'; + +const myQenv = new Qenv('path/to/dir/where/qenv.yml/is/', 'path/to/dir/where/env.yml/is('); +``` + +## Contribution + +We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :) + +For further information read the linked docs at the top of this readme. + +> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) +| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy) + +[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)