Skip to content

Commit 6d884d3

Browse files
committed
docs: update readme and release instructions
1 parent 282c23f commit 6d884d3

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,18 @@ $ yarn add dotenv-flow
2929

3030
## Usage
3131

32-
As early as possible in your application, require and configure **dotenv-flow**.
32+
As early as possible in your Node.js application initialize **dotenv-flow**:
3333

3434
```js
3535
require('dotenv-flow').config();
3636
```
3737

38+
or, if you're using typescript:
39+
40+
```ts
41+
import 'dotenv-flow/config';
42+
```
43+
3844
After this, you can access all the environment variables you have defined in your `.env*` files through `process.env.*`.
3945

4046
For example, let's suppose that you have the following `.env*` files in your project:

RELEASE.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@
22

33
## Shipping a new version
44

5-
1. Ensure you've pushed all the necessary changes to the repo and tests are successfully passed on TravisCI
5+
1. Make sure all the latest changes are pushed to the repo and all the related
6+
workflow tests are passing on CI (https://github.com/kerimdzhanov/dotenv-flow/actions)
67
2. Bump up the version in `package.json`
78
3. Update the `CHANGELOG.md` file using `$ yarn changelog`
89
4. Make a release commit with a message in format of `chore(release): vX.Y.Z`
910
5. Tag the release commit using `$ git tag vX.Y.X`
10-
6. Push the release commit (including the tag) to GitHub `$ git push && git push --tags`
11-
7. Publish the new package version using `$ yarn publish [--tag=next]`
11+
6. Push the release commit (with the tag) to GitHub `$ git push && git push --tags`
12+
7. Create a new version release on GitHub based on the created tag
13+
14+
> Once the release is published, Github Actions' workflow will build and publish the new package version to NPM.

0 commit comments

Comments
 (0)