Skip to content

Commit 6d176f8

Browse files
committed
Updated docs
1 parent c28a0ff commit 6d176f8

5 files changed

Lines changed: 124 additions & 10 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ node_modules
66
*.env
77
.DS_Store
88
package-lock.json
9+
.bloggify/*

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2017 Bloggify <support@bloggify.org> (https://bloggify.org)
3+
Copyright (c) 2017-20 Bloggify <support@bloggify.org> (https://bloggify.org)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 120 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,63 @@
11
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
22

33

4+
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
17+
18+
19+
420
# `$ obj2env`
521

622
[![Version](https://img.shields.io/npm/v/obj2env-cli.svg)](https://www.npmjs.com/package/obj2env-cli) [![Downloads](https://img.shields.io/npm/dt/obj2env-cli.svg)](https://www.npmjs.com/package/obj2env-cli)
723

24+
25+
26+
27+
28+
29+
830
> Create .env files in your terminal.
931
32+
33+
34+
35+
36+
37+
38+
39+
40+
41+
1042
[![obj2env-cli](http://i.imgur.com/yfKqx6W.gif)](#)
1143

44+
45+
46+
47+
48+
49+
1250
## :cloud: Installation
1351

1452
You can install the package globally and use it as command line tool:
1553

1654

1755
```sh
18-
$ npm i -g obj2env-cli
56+
# Using npm
57+
npm install --global obj2env-cli
58+
59+
# Using yarn
60+
yarn global add obj2env-cli
1961
```
2062

2163

@@ -29,14 +71,14 @@ Usage: obj2env [options]
2971
Create .env files in your terminal.
3072
3173
Options:
32-
-o, --output Output the content in the stdout.
74+
-c, --comment Add a help text for that variable.
75+
-d, --dir Specify the directory where to write the .env file.
76+
-i, --interactive Enables the interactive mode.
3377
-f, --force Overrides the existing file without user
3478
confirmation.
35-
-i, --interactive Enables the interactive mode.
36-
-d, --dir Specify the directory where to write the .env file.
37-
-c, --comment Add a help text for that variable.
38-
-v, --version Displays version information.
79+
-o, --output Output the content in the stdout.
3980
-h, --help Displays this help.
81+
-v, --version Displays version information.
4082
4183
Examples:
4284
$ obj2env PORT NODE_ENV
@@ -45,16 +87,87 @@ Examples:
4587
Documentation can be found at https://github.com/Bloggify/obj2env-cli#readme.
4688
```
4789

90+
91+
92+
93+
94+
95+
96+
97+
98+
99+
100+
101+
102+
103+
104+
105+
106+
107+
108+
109+
110+
111+
## :question: Get Help
112+
113+
There are few ways to get help:
114+
115+
116+
117+
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
118+
2. For bug reports and feature requests, open issues. :bug:
119+
120+
121+
122+
123+
124+
125+
126+
127+
128+
129+
130+
131+
132+
133+
134+
48135
## :yum: How to contribute
49136
Have an idea? Found a bug? See [how to contribute][contributing].
50137

51138

52139

140+
141+
142+
143+
144+
145+
146+
147+
148+
149+
150+
151+
152+
153+
154+
155+
156+
157+
158+
159+
160+
53161
## :scroll: License
54162

55163
[MIT][license] © [Bloggify][website]
56164

57-
[license]: http://showalicense.com/?fullname=Bloggify%20%3Csupport%40bloggify.org%3E%20(https%3A%2F%2Fbloggify.org)&year=2017#license-mit
165+
166+
167+
168+
169+
170+
[license]: /LICENSE
58171
[website]: https://bloggify.org
59172
[contributing]: /CONTRIBUTING.md
60173
[docs]: /DOCUMENTATION.md

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,4 @@
5050
"blah": {
5151
"ex_img": "http://i.imgur.com/yfKqx6W.gif"
5252
}
53-
}
53+
}

0 commit comments

Comments
 (0)