Skip to content

Commit ffe5012

Browse files
committed
update
1 parent d3bbbef commit ffe5012

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@ Node.js module for executing os commands against a pool of stateful, long-lived
33

44
It is important to note, that despite the use-case described below for this project's origination, this node module can be used for proxying long-lived bash process (or any shell really) in addition to powershell etc. It works and has been tested on both *nix, osx and windows hosts running the latest version of node.
55

6-
### Origin
6+
* [Origin](#origin)
7+
* [Usage](#usage)
8+
* [Example](#example)
9+
10+
### Origin <a id="Origin"></a>
711

812
This project originated out of the need to execute various Powershell commands (at fairly high volume and frequency) against services within Office365/Azure bridged via a custom node.js implemented REST API; this was due to the lack of certain features in the REST GraphAPI for Azure/o365, that are available only in Powershell.
913

@@ -17,7 +21,7 @@ The diagram below should conceptually give you an idea of what this module does.
1721

1822
![Alt text](/diagram.png "Diagram1")
1923

20-
### Usage
24+
### Usage <a id="usage"></a>
2125

2226
To use StatefulProcessCommandProxy the constructor takes one parameter which is a configuration object who's properties are described below. Please refer to the example (following) and the unit-test for more details.
2327

@@ -77,7 +81,7 @@ To use StatefulProcessCommandProxy the constructor takes one parameter which is
7781

7882
Its highly recommended you check out the unit-tests for some examples in addition to the below:
7983

80-
### Example
84+
### Example <a id="example"></a>
8185

8286
Note this example is for a machine w/ bash in the typical location. Windows (or other) can adjust the below as necessary to run).
8387

0 commit comments

Comments
 (0)