Skip to content

Commit

Permalink
chore(docs): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bittricky committed Dec 17, 2024
2 parents aa80282 + f4fbb5e commit 6a612da
Showing 1 changed file with 30 additions and 67 deletions.
97 changes: 30 additions & 67 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,84 +9,45 @@ A command line tool to generate random lottery numbers
[![Downloads/week](https://img.shields.io/npm/dw/jackpot-cli.svg)](https://www.npmjs.com/package/jackpot-cli)

<!-- toc -->
* [jackpot-cli](#jackpot-cli)
* [Usage](#usage)
* [Commands](#commands)

- [jackpot-cli](#jackpot-cli)
- [Usage](#usage)
- [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->

```sh-session
$ npm install -g jackpot-cli
$ jackpot COMMAND
running command...
$ jackpot (--version)
jackpot-cli/1.1.0 darwin-x64 node-v20.9.0
jackpot-cli/1.1.0 linux-x64 node-v18.20.5
$ jackpot --help [COMMAND]
USAGE
$ jackpot COMMAND
...
```

<!-- usagestop -->

# Commands

<!-- commands -->
* [`jackpot generate`](#jackpot-generate)
* [`jackpot help [COMMAND]`](#jackpot-help-command)
* [`jackpot plugins`](#jackpot-plugins)
* [`jackpot plugins:add PLUGIN`](#jackpot-pluginsadd-plugin)
* [`jackpot plugins:inspect PLUGIN...`](#jackpot-pluginsinspect-plugin)
* [`jackpot plugins:install PLUGIN`](#jackpot-pluginsinstall-plugin)
* [`jackpot plugins:link PATH`](#jackpot-pluginslink-path)
* [`jackpot plugins:remove [PLUGIN]`](#jackpot-pluginsremove-plugin)
* [`jackpot plugins:reset`](#jackpot-pluginsreset)
* [`jackpot plugins:uninstall [PLUGIN]`](#jackpot-pluginsuninstall-plugin)
* [`jackpot plugins:unlink [PLUGIN]`](#jackpot-pluginsunlink-plugin)
* [`jackpot plugins:update`](#jackpot-pluginsupdate)

## `jackpot generate`

Generate lottery numbers for major global lotteries

```
USAGE
$ jackpot generate -l <value>
FLAGS
-l, --lotto=<value> (required) type of lottery
DESCRIPTION
Generate lottery numbers for major global lotteries
EXAMPLES
$ jackpot generate --lotto auspowerball
$ jackpot generate --lotto canada649

$ jackpot generate --lotto canadamax
$ jackpot generate --lotto elgordo
$ jackpot generate --lotto euromillions
$ jackpot generate --lotto franceloto
$ jackpot generate --lotto germanlotto
$ jackpot generate --lotto megamillions
$ jackpot generate --lotto ozlotto
$ jackpot generate --lotto powerball
$ jackpot generate --lotto superenalotto
$ jackpot generate --lotto uklotto
```

_See code: [src/commands/generate.ts](https://github.com/bittricky/jackpot-cli/blob/v1.1.0/src/commands/generate.ts)_
- [`jackpot help [COMMAND]`](#jackpot-help-command)
- [`jackpot plugins`](#jackpot-plugins)
- [`jackpot plugins:add PLUGIN`](#jackpot-pluginsadd-plugin)
- [`jackpot plugins:inspect PLUGIN...`](#jackpot-pluginsinspect-plugin)
- [`jackpot plugins:install PLUGIN`](#jackpot-pluginsinstall-plugin)
- [`jackpot plugins:link PATH`](#jackpot-pluginslink-path)
- [`jackpot plugins:remove [PLUGIN]`](#jackpot-pluginsremove-plugin)
- [`jackpot plugins:reset`](#jackpot-pluginsreset)
- [`jackpot plugins:uninstall [PLUGIN]`](#jackpot-pluginsuninstall-plugin)
- [`jackpot plugins:unlink [PLUGIN]`](#jackpot-pluginsunlink-plugin)
- [`jackpot plugins:update`](#jackpot-pluginsupdate)

## `jackpot help [COMMAND]`

Expand All @@ -106,7 +67,7 @@ DESCRIPTION
Display help for jackpot.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.22/src/commands/help.ts)_
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.19/src/commands/help.ts)_

## `jackpot plugins`

Expand All @@ -129,7 +90,7 @@ EXAMPLES
$ jackpot plugins
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/index.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/index.ts)_

## `jackpot plugins:add PLUGIN`

Expand All @@ -154,7 +115,7 @@ GLOBAL FLAGS
DESCRIPTION
Installs a plugin into jackpot.
Uses bundled npm executable to install plugins into /Users/bittricky/.local/share/jackpot
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Expand Down Expand Up @@ -203,7 +164,7 @@ EXAMPLES
$ jackpot plugins:inspect myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/inspect.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/inspect.ts)_

## `jackpot plugins:install PLUGIN`

Expand All @@ -228,7 +189,7 @@ GLOBAL FLAGS
DESCRIPTION
Installs a plugin into jackpot.
Uses bundled npm executable to install plugins into /Users/bittricky/.local/share/jackpot
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Expand All @@ -252,7 +213,7 @@ EXAMPLES
$ jackpot plugins:install someuser/someplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/install.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/install.ts)_

## `jackpot plugins:link PATH`

Expand All @@ -272,6 +233,7 @@ FLAGS
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
Expand All @@ -282,7 +244,7 @@ EXAMPLES
$ jackpot plugins:link myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/link.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/link.ts)_

## `jackpot plugins:remove [PLUGIN]`

Expand Down Expand Up @@ -323,7 +285,7 @@ FLAGS
--reinstall Reinstall all plugins after uninstalling.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/reset.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/reset.ts)_

## `jackpot plugins:uninstall [PLUGIN]`

Expand Down Expand Up @@ -351,7 +313,7 @@ EXAMPLES
$ jackpot plugins:uninstall myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/uninstall.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/uninstall.ts)_

## `jackpot plugins:unlink [PLUGIN]`

Expand Down Expand Up @@ -395,7 +357,8 @@ DESCRIPTION
Update installed plugins.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/update.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/update.ts)_

<!-- commandsstop -->

- [`jackpot generate`](#jackpot-generate)
Expand Down

0 comments on commit 6a612da

Please sign in to comment.