Skip to content

Commit 3208075

Browse files
committed
docs: usage
Signed-off-by: Lexus Drumgold <[email protected]>
1 parent 508f175 commit 3208075

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,31 @@ yarn add -D @flex-development/toggle-pkg-type@flex-development/toggle-pkg-type
6161

6262
## Usage
6363

64-
**TODO**: Update documentation.
64+
### CLI
65+
66+
```sh
67+
Usage
68+
$ toggle-pkg-type [off|on] [options]
69+
70+
Options
71+
-v, --version Displays current version
72+
-h, --help Displays this message
73+
74+
Examples
75+
$ toggle-pkg-type
76+
$ toggle-pkg-type off
77+
$ toggle-pkg-type on
78+
```
79+
80+
### Programmatic
81+
82+
```javascript
83+
import toggle from '@flex-development/toggle-pkg-type'
84+
85+
toggle()
86+
toggle('off')
87+
toggle('on)
88+
```
6589
6690
[1]:
6791
https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries

0 commit comments

Comments
 (0)