From 8d3f30b09bde8dca4b22475077d98065b5ff4d9f Mon Sep 17 00:00:00 2001 From: Mitul Patel Date: Fri, 31 May 2024 17:57:57 -0400 Subject: [PATCH] fix(docs): cleaned up the documentation --- README.md | 342 ++---------------------------------------------------- 1 file changed, 12 insertions(+), 330 deletions(-) diff --git a/README.md b/README.md index dc94def..7f82368 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # lottery-cli -Command line tool to generate global lottery numbers +> Do you feel lucky? Well... Let's roll the dice and find out 🎲. + +A Command line tool to generate global lottery numbers [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) @@ -9,6 +11,7 @@ Command line tool to generate global lottery numbers +- [lottery-cli](#lottery-cli) - [Usage](#usage) - [Commands](#commands) @@ -35,61 +38,31 @@ USAGE -- [`lottery hello PERSON`](#lottery-hello-person) -- [`lottery hello world`](#lottery-hello-world) +- [`lottery generate`](#lottery-generate) - [`lottery help [COMMAND]`](#lottery-help-command) -- [`lottery plugins`](#lottery-plugins) -- [`lottery plugins add PLUGIN`](#lottery-plugins-add-plugin) -- [`lottery plugins:inspect PLUGIN...`](#lottery-pluginsinspect-plugin) -- [`lottery plugins install PLUGIN`](#lottery-plugins-install-plugin) -- [`lottery plugins link PATH`](#lottery-plugins-link-path) -- [`lottery plugins remove [PLUGIN]`](#lottery-plugins-remove-plugin) -- [`lottery plugins reset`](#lottery-plugins-reset) -- [`lottery plugins uninstall [PLUGIN]`](#lottery-plugins-uninstall-plugin) -- [`lottery plugins unlink [PLUGIN]`](#lottery-plugins-unlink-plugin) -- [`lottery plugins update`](#lottery-plugins-update) -## `lottery hello PERSON` +## `lottery generate` -Say hello +Generate lottery numbers for major global lotteries ``` USAGE - $ lottery hello PERSON -f + $ lottery generate -l ARGUMENTS PERSON Person to say hello to FLAGS - -f, --from= (required) Who is saying hello - -DESCRIPTION - Say hello - -EXAMPLES - $ lottery hello friend --from oclif - hello friend from oclif! (./src/commands/hello/index.ts) -``` - -_See code: [src/commands/hello/index.ts](https://github.com/bittricky/lottery-cli/blob/v0.0.0/src/commands/hello/index.ts)_ - -## `lottery hello world` - -Say hello world - -``` -USAGE - $ lottery hello world + -l, --lotto= (required) name of major lottery DESCRIPTION - Say hello world + Generate lottery numbers for major global lotteries EXAMPLES - $ lottery hello world - hello world! (./src/commands/hello/world.ts) + $ lottery generate --lotto megamillions ``` -_See code: [src/commands/hello/world.ts](https://github.com/bittricky/lottery-cli/blob/v0.0.0/src/commands/hello/world.ts)_ +_See code: [src/commands/hello/index.ts](https://github.com/bittricky/lottery-cli/blob/v0.0.0/src/commands/generate.ts)_ ## `lottery help [COMMAND]` @@ -110,294 +83,3 @@ DESCRIPTION ``` _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.22/src/commands/help.ts)_ - -## `lottery plugins` - -List installed plugins. - -``` -USAGE - $ lottery plugins [--json] [--core] - -FLAGS - --core Show core plugins. - -GLOBAL FLAGS - --json Format output as json. - -DESCRIPTION - List installed plugins. - -EXAMPLES - $ lottery plugins -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/index.ts)_ - -## `lottery plugins add PLUGIN` - -Installs a plugin into lottery. - -``` -USAGE - $ lottery plugins add PLUGIN... [--json] [-f] [-h] [-s | -v] - -ARGUMENTS - PLUGIN... Plugin to install. - -FLAGS - -f, --force Force npm to fetch remote resources even if a local copy exists on disk. - -h, --help Show CLI help. - -s, --silent Silences npm output. - -v, --verbose Show verbose npm output. - -GLOBAL FLAGS - --json Format output as json. - -DESCRIPTION - Installs a plugin into lottery. - - Uses bundled npm executable to install plugins into /Users/bittricky/.local/share/lottery - - Installation of a user-installed plugin will override a core plugin. - - Use the LOTTERY_NPM_LOG_LEVEL environment variable to set the npm loglevel. - Use the LOTTERY_NPM_REGISTRY environment variable to set the npm registry. - -ALIASES - $ lottery plugins add - -EXAMPLES - Install a plugin from npm registry. - - $ lottery plugins add myplugin - - Install a plugin from a github url. - - $ lottery plugins add https://github.com/someuser/someplugin - - Install a plugin from a github slug. - - $ lottery plugins add someuser/someplugin -``` - -## `lottery plugins:inspect PLUGIN...` - -Displays installation properties of a plugin. - -``` -USAGE - $ lottery plugins inspect PLUGIN... - -ARGUMENTS - PLUGIN... [default: .] Plugin to inspect. - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -GLOBAL FLAGS - --json Format output as json. - -DESCRIPTION - Displays installation properties of a plugin. - -EXAMPLES - $ lottery plugins inspect myplugin -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/inspect.ts)_ - -## `lottery plugins install PLUGIN` - -Installs a plugin into lottery. - -``` -USAGE - $ lottery plugins install PLUGIN... [--json] [-f] [-h] [-s | -v] - -ARGUMENTS - PLUGIN... Plugin to install. - -FLAGS - -f, --force Force npm to fetch remote resources even if a local copy exists on disk. - -h, --help Show CLI help. - -s, --silent Silences npm output. - -v, --verbose Show verbose npm output. - -GLOBAL FLAGS - --json Format output as json. - -DESCRIPTION - Installs a plugin into lottery. - - Uses bundled npm executable to install plugins into /Users/bittricky/.local/share/lottery - - Installation of a user-installed plugin will override a core plugin. - - Use the LOTTERY_NPM_LOG_LEVEL environment variable to set the npm loglevel. - Use the LOTTERY_NPM_REGISTRY environment variable to set the npm registry. - -ALIASES - $ lottery plugins add - -EXAMPLES - Install a plugin from npm registry. - - $ lottery plugins install myplugin - - Install a plugin from a github url. - - $ lottery plugins install https://github.com/someuser/someplugin - - Install a plugin from a github slug. - - $ lottery plugins install someuser/someplugin -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/install.ts)_ - -## `lottery plugins link PATH` - -Links a plugin into the CLI for development. - -``` -USAGE - $ lottery plugins link PATH [-h] [--install] [-v] - -ARGUMENTS - PATH [default: .] path to plugin - -FLAGS - -h, --help Show CLI help. - -v, --verbose - --[no-]install Install dependencies after linking the plugin. - -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' - command will override the user-installed or core plugin implementation. This is useful for development work. - - -EXAMPLES - $ lottery plugins link myplugin -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/link.ts)_ - -## `lottery plugins remove [PLUGIN]` - -Removes a plugin from the CLI. - -``` -USAGE - $ lottery plugins remove [PLUGIN...] [-h] [-v] - -ARGUMENTS - PLUGIN... plugin to uninstall - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -DESCRIPTION - Removes a plugin from the CLI. - -ALIASES - $ lottery plugins unlink - $ lottery plugins remove - -EXAMPLES - $ lottery plugins remove myplugin -``` - -## `lottery plugins reset` - -Remove all user-installed and linked plugins. - -``` -USAGE - $ lottery plugins reset [--hard] [--reinstall] - -FLAGS - --hard Delete node_modules and package manager related files in addition to uninstalling plugins. - --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)_ - -## `lottery plugins uninstall [PLUGIN]` - -Removes a plugin from the CLI. - -``` -USAGE - $ lottery plugins uninstall [PLUGIN...] [-h] [-v] - -ARGUMENTS - PLUGIN... plugin to uninstall - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -DESCRIPTION - Removes a plugin from the CLI. - -ALIASES - $ lottery plugins unlink - $ lottery plugins remove - -EXAMPLES - $ lottery plugins uninstall myplugin -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/uninstall.ts)_ - -## `lottery plugins unlink [PLUGIN]` - -Removes a plugin from the CLI. - -``` -USAGE - $ lottery plugins unlink [PLUGIN...] [-h] [-v] - -ARGUMENTS - PLUGIN... plugin to uninstall - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -DESCRIPTION - Removes a plugin from the CLI. - -ALIASES - $ lottery plugins unlink - $ lottery plugins remove - -EXAMPLES - $ lottery plugins unlink myplugin -``` - -## `lottery plugins update` - -Update installed plugins. - -``` -USAGE - $ lottery plugins update [-h] [-v] - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -DESCRIPTION - Update installed plugins. -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/update.ts)_ - -