Skip to content

Commit 14809be

Browse files
Fix Links, Add Install Instructions
1 parent 371877f commit 14809be

2 files changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,17 @@
99
Ever wanted to try out someone's project and kept figuring out all the environment variables that were needed ? Or you are just too lazy to document the same in your own project ? Worry not !
1010

1111
This is a simple npm package that will read through the entire codebase (don't worry, only javascript and typescript files) of your project, and create a `.env.example` file with all the environment configurations that are used in the code.
12+
13+
---
14+
15+
## Usage
16+
17+
```bash
18+
# install the package using
19+
sudo npm i -g @hackcode/env-example-generator
20+
21+
# run the cli from the project root
22+
generate-env
23+
24+
# An .env.example file would be created
25+
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
},
1010
"repository": {
1111
"type": "git",
12-
"url": "git+https://github.com/yashkumarverma/env-example-generator/.git"
12+
"url": "https://github.com/hackcode-packages/env-example-generator"
1313
},
1414
"keywords": [
1515
"env",

0 commit comments

Comments
 (0)