Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Dec 6, 2017
1 parent fb8f982 commit f4d6845
Show file tree
Hide file tree
Showing 5 changed files with 930 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@
*.log
node_modules
*.env
.DS_Store
package-lock.json
3 changes: 3 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ You can see below the API reference of this module.
Converts the pair of name and value into a string.

#### Params

- **String** `name`: The environment variable name.
- **String** `value`: The environment variable value.

Expand All @@ -16,6 +17,7 @@ Converts the pair of name and value into a string.
Converts an object of environment variables into an array.

#### Params

- **Object** `obj`: The object containing environment variables to stringify.

#### Return
Expand All @@ -25,6 +27,7 @@ Converts an object of environment variables into an array.
Create a file named `.env` in the specified directory.

#### Params

- **Object** `obj`: The object containing environment variables to stringify.
- **String** `dir`: The directory where to create the `.env` file (default: the current directory).
- **Function** `cb`: The callback function.
Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->


# obj2env

Expand Down Expand Up @@ -50,7 +52,7 @@ There are few ways to get help:

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.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:



## :memo: Documentation
Expand All @@ -60,6 +62,7 @@ There are few ways to get help:
Converts the pair of name and value into a string.

#### Params

- **String** `name`: The environment variable name.
- **String** `value`: The environment variable value.

Expand All @@ -70,6 +73,7 @@ Converts the pair of name and value into a string.
Converts an object of environment variables into an array.

#### Params

- **Object** `obj`: The object containing environment variables to stringify.

#### Return
Expand All @@ -79,6 +83,7 @@ Converts an object of environment variables into an array.
Create a file named `.env` in the specified directory.

#### Params

- **Object** `obj`: The object containing environment variables to stringify.
- **String** `dir`: The directory where to create the `.env` file (default: the current directory).
- **Function** `cb`: The callback function.
Expand All @@ -92,6 +97,11 @@ Create a file named `.env` in the specified directory.
Have an idea? Found a bug? See [how to contribute][contributing].


## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:


- [`obj2env-cli`](https://github.com/Bloggify/obj2env-cli#readme) (by Bloggify)—Create .env files in your terminal.

## :scroll: License

Expand Down
Loading

0 comments on commit f4d6845

Please sign in to comment.