From 30d4be87b4cb9bee82c9aa0754523126c76dde1e Mon Sep 17 00:00:00 2001 From: Chris Schneider Date: Wed, 12 Jul 2017 15:17:42 +0200 Subject: [PATCH 1/2] Improved README --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2dae66b..e805656 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,10 @@ Key features: - Environment variables can be loaded with *dotenv* at startup in Lambda without delays from KMS. - Supports *serverless-local-dev-server* for local development. +For a brief introduction, read our blogpost about [introducing serverless-env-generator](http://www.dieproduktmacher.com/introducing-serverless-env-generator/). + +### Notes + Please note that the uploaded *.env* file contains secrets in cleartext. Therefore we recommend to use [Serverless Crypt](https://github.com/marcy-terui/serverless-crypt) for critical secrets. This tool aims to strike a balance between storing secrets in plaintext in Lambda environment variables and having to decrypt them at runtime using KMS. Furthermore the tool does not support environment variables generated by Serverless. We recommend to set these variables directly in each functions configuration in *serverless.yml*. @@ -21,7 +25,7 @@ Furthermore the tool does not support environment variables generated by Serverl When used with *serverless-local-dev-server* your environment variables are directly loaded into *process.env*. No *.env* file is created to make sure that your local development and deployment tasks do not interfere :-) This package requires node >= 6.0. -Encryption is only supported for AWS due to the reliance on KMS. +Due to the reliance on KMS, encryption is only supported for AWS. # Table of Contents From 0d6d83d2f93c4829b6a86318b649bf8604e80370 Mon Sep 17 00:00:00 2001 From: Chris Schneider Date: Wed, 12 Jul 2017 15:19:31 +0200 Subject: [PATCH 2/2] Improved README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e805656..9598c85 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,10 @@ Serverless Env Generator Plugin This plugin automatically creates a *.env* file during deployment by merging environment variables from one or more YAML files. During runtime these variables can then be loaded into *process.env* using *dotenv*. -Key features: +For a brief introduction, read our blogpost about [introducing serverless-env-generator](http://www.dieproduktmacher.com/introducing-serverless-env-generator/). + + +### Key features: - Support for multi-stage configurations and custom profiles - Value of environment variables can be encrypted with AWS KMS, allowing teams to manage sensitive information in git. @@ -14,7 +17,6 @@ Key features: - Environment variables can be loaded with *dotenv* at startup in Lambda without delays from KMS. - Supports *serverless-local-dev-server* for local development. -For a brief introduction, read our blogpost about [introducing serverless-env-generator](http://www.dieproduktmacher.com/introducing-serverless-env-generator/). ### Notes