Skip to content

Commit 58e70fa

Browse files
committed
update readme
1 parent 4c92c14 commit 58e70fa

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

.changeset/ninety-coins-arrive.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'puntoenv': patch
3+
---
4+
5+
Update Readme

README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,25 @@ PuntoEnv is a simple package that enables you to load `.env` files in to `proces
77

88
<!-- toc -->
99

10-
- [PuntoEnv](#puntoenv)
11-
- [Motivation](#motivation)
12-
- [Getting Started](#getting-started)
13-
- [How it works.](#how-it-works)
14-
- [Variable expansion](#variable-expansion)
15-
- [License](#license)
10+
- [Motivation](#motivation)
11+
- [Installation](#installation)
12+
- [Getting Started](#getting-started)
13+
- [How it works.](#how-it-works)
14+
* [Variable expansion](#variable-expansion)
15+
- [License](#license)
1616

1717
<!-- tocstop -->
1818

1919
## Motivation
2020

2121
I like how [Next.js loads `.env` files](https://nextjs.org/docs/basic-features/environment-variables#environment-variable-load-order) so I decided to make a similar utility module so I could use it everywhere else. Under the hood, it uses [`dotenv`](https://www.npmjs.com/package/dotenv) and [`dotenv-expand`](https://www.npmjs.com/package/dotenv-expand) packages.
2222

23+
## Installation
24+
25+
```sh
26+
npm i puntoenv
27+
```
28+
2329
## Getting Started
2430

2531
Setup is really simple, just pass in a path to the directory that has your `.env` files and that's it!

0 commit comments

Comments
 (0)