Skip to content

Commit

Permalink
docs: usage
Browse files Browse the repository at this point in the history
Signed-off-by: Lexus Drumgold <[email protected]>
  • Loading branch information
unicornware committed Oct 2, 2022
1 parent 508f175 commit 3208075
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,31 @@ yarn add -D @flex-development/toggle-pkg-type@flex-development/toggle-pkg-type

## Usage

**TODO**: Update documentation.
### CLI

```sh
Usage
$ toggle-pkg-type [off|on] [options]

Options
-v, --version Displays current version
-h, --help Displays this message

Examples
$ toggle-pkg-type
$ toggle-pkg-type off
$ toggle-pkg-type on
```

### Programmatic

```javascript
import toggle from '@flex-development/toggle-pkg-type'

toggle()
toggle('off')
toggle('on)
```
[1]:
https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries
Expand Down

0 comments on commit 3208075

Please sign in to comment.