Skip to content

Commit badb75f

Browse files
committed
Updated docs
1 parent 66c16de commit badb75f

File tree

3 files changed

+12
-2
lines changed

3 files changed

+12
-2
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,6 @@
33
*~
44
*.log
55
node_modules
6+
*.env
7+
.DS_Store
8+
package-lock.json

DOCUMENTATION.md

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ You can see below the API reference of this module.
55
### `PowerShell(input, opt, cb)`
66

77
#### Params
8+
89
- **String** `input`: The command or PowerShell script ro execute.
910
- **Object** `opt`: An object containing the following fields:
1011
- `debug` (Boolean): Turn on/off the debug messages (default: `false`).

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
2+
13

24
# powershell
35

4-
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Version](https://img.shields.io/npm/v/powershell.svg)](https://www.npmjs.com/package/powershell) [![Downloads](https://img.shields.io/npm/dt/powershell.svg)](https://www.npmjs.com/package/powershell)
6+
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/powershell.svg)](https://www.npmjs.com/package/powershell) [![Downloads](https://img.shields.io/npm/dt/powershell.svg)](https://www.npmjs.com/package/powershell)
57

68
> Run PowerShell scripts and commands from Node.js.
79
@@ -50,13 +52,15 @@ ps.on("end", code => {
5052
});
5153
```
5254

55+
56+
5357
## :question: Get Help
5458

5559
There are few ways to get help:
5660

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

6165

6266
## :memo: Documentation
@@ -65,6 +69,7 @@ There are few ways to get help:
6569
### `PowerShell(input, opt, cb)`
6670

6771
#### Params
72+
6873
- **String** `input`: The command or PowerShell script ro execute.
6974
- **Object** `opt`: An object containing the following fields:
7075
- `debug` (Boolean): Turn on/off the debug messages (default: `false`).
@@ -86,6 +91,7 @@ this takes time. You can integrate and use these projects in your applications *
8691
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
8792

8893
- Starring and sharing the projects you like :rocket:
94+
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
8995
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
9096
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
9197
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`

0 commit comments

Comments
 (0)