Skip to content

Commit d64cc8d

Browse files
authored
chore: update package.json and README.md (#5)
1 parent abc9443 commit d64cc8d

File tree

2 files changed

+71
-20
lines changed

2 files changed

+71
-20
lines changed

README.md

Lines changed: 52 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,22 @@
55
[![Donate](https://img.shields.io/badge/dynamic/json?color=%23ff424d&label=Patreon&style=flat-square&query=data.attributes.patron_count&suffix=%20patrons&url=https%3A%2F%2Fwww.patreon.com%2Fapi%2Fcampaigns%2F233228)](http://patreon.com/koistya)
66
[![Discord](https://img.shields.io/discord/643523529131950086?label=Chat&style=flat-square)](https://discord.gg/bSsv7XM)
77

8-
Loads environment variables for the target environment from `.env` files using [dotenv](https://github.com/motdotla/dotenv); supports cloud secret providers such as [Google Secret Manager](https://cloud.google.com/secret-manager).
8+
Loads environment variables for the target environment from `.env` files using [dotenv](https://github.com/motdotla/dotenv). Also supports cloud secret providers such as [Google Secret Manager](https://cloud.google.com/secret-manager), [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/), and (experimental) Azure Key Vault. Now you can keep your secrets secret, even from yourself.
9+
10+
## Features
11+
12+
- Loads `.env` files using Vite-style conventions
13+
- Supports secret references from Google, AWS, and Azure
14+
- TypeScript and monorepo friendly
15+
- Works with Vite, Node.js, and serverless deployments
16+
- Simple API, zero-config for most use cases
17+
18+
## Why envars?
19+
20+
- **Unified config**: Manage local and cloud secrets with a single API.
21+
- **Predictable**: Follows conventions from Vite and modern Node.js tooling.
22+
- **Flexible**: Works in monorepos, serverless, and traditional deployments.
23+
- **Type-safe**: Integrates with envalid, Zod, and other schema validators.
924

1025
By default it attempts to load `.env` files from the current working directory using the following naming convention ([learn more](https://vitejs.dev/guide/env-and-mode.html#env-files)):
1126

@@ -18,19 +33,30 @@ By default it attempts to load `.env` files from the current working directory u
1833

1934
Created and diligently upheld with the generous backing of these exceptional companies:
2035

21-
<a href="https://reactstarter.com/s/1"><img src="https://reactstarter.com/s/1.png" height="60" /></a>&nbsp;&nbsp;<a href="https://reactstarter.com/s/2"><img src="https://reactstarter.com/s/2.png" height="60" /></a>&nbsp;&nbsp;<a href="https://reactstarter.com/s/3"><img src="https://reactstarter.com/s/3.png" height="60" /></a>
36+
[<img src="https://reactstarter.com/s/1.png" height="60" alt="Sponsor 1" />](https://reactstarter.com/s/1)
37+
&nbsp;&nbsp;[<img src="https://reactstarter.com/s/2.png" height="60" alt="Sponsor 2" />](https://reactstarter.com/s/2)
38+
&nbsp;&nbsp;[<img src="https://reactstarter.com/s/3.png" height="60" alt="Sponsor 3" />](https://reactstarter.com/s/3)
2239

2340
## How to Install
2441

2542
```bash
2643
# with NPM
27-
$ npm install envars --save-dev
44+
npm install envars --save-dev
2845

2946
# with Yarn
30-
$ yarn add envars --dev
47+
yarn add envars --dev
3148
```
3249

33-
## Usage
50+
## Quick Start
51+
52+
```js
53+
import { loadEnv } from "envars";
54+
55+
const [env] = await loadEnv("development");
56+
console.log(env);
57+
```
58+
59+
## Advanced Usage
3460

3561
```dotenv
3662
# .env
@@ -162,31 +188,45 @@ export default defineConfig(async ({ mode }) => {
162188
### References
163189

164190
- https://cloud.google.com/secret-manager/docs
191+
- https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
192+
- https://learn.microsoft.com/en-us/azure/key-vault/secrets/
165193

166194
## Backers 💰
167195

168-
<a href="https://reactstarter.com/b/1"><img src="https://reactstarter.com/b/1.png" height="60" /></a>&nbsp;&nbsp;<a href="https://reactstarter.com/b/2"><img src="https://reactstarter.com/b/2.png" height="60" /></a>&nbsp;&nbsp;<a href="https://reactstarter.com/b/3"><img src="https://reactstarter.com/b/3.png" height="60" /></a>&nbsp;&nbsp;<a href="https://reactstarter.com/b/4"><img src="https://reactstarter.com/b/4.png" height="60" /></a>&nbsp;&nbsp;<a href="https://reactstarter.com/b/5"><img src="https://reactstarter.com/b/5.png" height="60" /></a>&nbsp;&nbsp;<a href="https://reactstarter.com/b/6"><img src="https://reactstarter.com/b/6.png" height="60" /></a>&nbsp;&nbsp;<a href="https://reactstarter.com/b/7"><img src="https://reactstarter.com/b/7.png" height="60" /></a>&nbsp;&nbsp;<a href="https://reactstarter.com/b/8"><img src="https://reactstarter.com/b/8.png" height="60" /></a>
196+
[<img src="https://reactstarter.com/b/1.png" height="60" alt="Backer 1" />](https://reactstarter.com/b/1)
197+
&nbsp;&nbsp;[<img src="https://reactstarter.com/b/2.png" height="60" alt="Backer 2" />](https://reactstarter.com/b/2)
198+
&nbsp;&nbsp;[<img src="https://reactstarter.com/b/3.png" height="60" alt="Backer 3" />](https://reactstarter.com/b/3)
199+
&nbsp;&nbsp;[<img src="https://reactstarter.com/b/4.png" height="60" alt="Backer 4" />](https://reactstarter.com/b/4)
200+
&nbsp;&nbsp;[<img src="https://reactstarter.com/b/5.png" height="60" alt="Backer 5" />](https://reactstarter.com/b/5)
201+
&nbsp;&nbsp;[<img src="https://reactstarter.com/b/6.png" height="60" alt="Backer 6" />](https://reactstarter.com/b/6)
202+
&nbsp;&nbsp;[<img src="https://reactstarter.com/b/7.png" height="60" alt="Backer 7" />](https://reactstarter.com/b/7)
203+
&nbsp;&nbsp;[<img src="https://reactstarter.com/b/8.png" height="60" alt="Backer 8" />](https://reactstarter.com/b/8)
169204

170205
## Related Projects
171206

172207
- [React Starter Kit](https://github.com/kriasoft/react-starter-kit) — front-end boilerplate (TypeScript, React, Material UI, Vite)
173208
- [Full-stack Starter Kit](https://github.com/kriasoft/relay-starter-kit) — monorepo boilerplate (TypeScript, Vite, GraphQL.js, React, and Relay)
174209

210+
## Community & Support
211+
212+
- 💬 [Join our Discord](https://discord.gg/bSsv7XM) for questions, help, and discussion (or just to show off your best `.env` puns)
213+
- 🐞 [Report issues](https://github.com/kriasoft/envars/issues) or request features on GitHub
214+
- 🙏 [Sponsor development](https://github.com/sponsors/koistya) to support ongoing maintenance (we promise not to spend it all on coffee)
215+
175216
## How to Contribute
176217

177218
Please [fork the repo](https://github.com/kriasoft/envars/fork), create a [PR](https://docs.github.com/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request), or send me a message on [Discord](https://discord.gg/bSsv7XM) (`@koistya`).
178219

179220
```bash
180-
$ git clone https://github.com/<username>/envars.git
181-
$ cd ./envars
182-
$ corepack enable
183-
$ yarn test
221+
git clone https://github.com/<username>/envars.git
222+
cd ./envars
223+
corepack enable
224+
yarn test
184225
```
185226

186227
## License
187228

188-
Copyright © 2021-present Kriasoft. This source code is licensed under the MIT license found in the
189-
[LICENSE](https://github.com/kriasoft/envars/blob/main/LICENSE) file.
229+
Copyright © 2021-present Kriasoft. This source code is licensed under the [MIT license](https://github.com/kriasoft/envars/blob/main/LICENSE).
190230

191231
---
192232

package.json

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,36 @@
22
"name": "envars",
33
"version": "1.1.1",
44
"packageManager": "yarn@4.9.2",
5-
"description": "Load environment variables from .env files. Decode secret values from AWS Secrets Manager, Google Secret Manager, and other sources.",
5+
"description": "Load environment variables from .env files and resolve secrets from AWS Secrets Manager, Google Secret Manager, and other providers.",
66
"keywords": [
77
".env",
8+
"12factor",
89
"aws",
10+
"cloud secrets",
911
"cloud",
1012
"config",
13+
"configuration",
14+
"deployment",
15+
"development",
1116
"dotenv",
1217
"env",
18+
"envalid",
1319
"environment variables",
1420
"environment",
1521
"expand",
1622
"gcp",
1723
"google",
24+
"monorepo",
25+
"nodejs",
26+
"production",
27+
"runtime config",
1828
"secret manager",
1929
"secret",
2030
"secrets management",
2131
"secrets",
32+
"secure",
33+
"serverless",
34+
"typescript",
2235
"variables",
2336
"vite"
2437
],
@@ -78,12 +91,10 @@
7891
},
7992
"ava": {
8093
"workerThreads": false,
81-
"watchMode": {
82-
"ignoreChanges": [
83-
".env.*",
84-
".env",
85-
"env.ts"
86-
]
87-
}
94+
"ignoredByWatcher": [
95+
".env.*",
96+
".env",
97+
"env.ts"
98+
]
8899
}
89100
}

0 commit comments

Comments
 (0)