Skip to content

Commit

Permalink
docs: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lgandecki committed Aug 22, 2023
1 parent 4986bfd commit a1881dd
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 6 deletions.
32 changes: 28 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ $ npm install -g chimp
$ chimp COMMAND
running command...
$ chimp (--version)
chimp/6.0.0-alpha.0 darwin-arm64 node-v18.1.0
chimp/0.0.0-development darwin-arm64 node-v18.1.0
$ chimp --help [COMMAND]
USAGE
$ chimp COMMAND
Expand All @@ -29,6 +29,7 @@ USAGE
# Commands
<!-- commands -->
* [`chimp create NAME`](#chimp-create-name)
* [`chimp eject`](#chimp-eject)
* [`chimp generate`](#chimp-generate)
* [`chimp help [COMMANDS]`](#chimp-help-commands)
* [`chimp init`](#chimp-init)
Expand Down Expand Up @@ -58,7 +59,30 @@ EXAMPLES
$ chimp create my-new-app -a ~src -g ~chimp-helpers
```

_See code: [src/commands/create.ts](https://github.com/xolvio/chimp/blob/v6.0.0-alpha.0/src/commands/create.ts)_
_See code: [src/commands/create.ts](https://github.com/xolvio/chimp/blob/v0.0.0-development/src/commands/create.ts)_

## `chimp eject`

Eject from chimp. While chimp is not a runtime dependency and your project will still run after removing it, ejecting offers a cleaner development environment. While we hope you never need to eject, it is reassuring to know you have the option. If you choose to eject or are considering it, please inform us. Remember, you are always just one command away from this choice.

```
USAGE
$ chimp eject [-h]
FLAGS
-h, --help Show CLI help.
DESCRIPTION
Eject from chimp. While chimp is not a runtime dependency and your project will still run after removing it, ejecting
offers a cleaner development environment. While we hope you never need to eject, it is reassuring to know you have the
option. If you choose to eject or are considering it, please inform us. Remember, you are always just one command away
from this choice.
EXAMPLES
$ chimp eject
```

_See code: [src/commands/eject.ts](https://github.com/xolvio/chimp/blob/v0.0.0-development/src/commands/eject.ts)_

## `chimp generate`

Expand All @@ -84,7 +108,7 @@ EXAMPLES
$ chimp generate -a ~src -g ~chimp-helpers
```

_See code: [src/commands/generate.ts](https://github.com/xolvio/chimp/blob/v6.0.0-alpha.0/src/commands/generate.ts)_
_See code: [src/commands/generate.ts](https://github.com/xolvio/chimp/blob/v0.0.0-development/src/commands/generate.ts)_

## `chimp help [COMMANDS]`

Expand Down Expand Up @@ -127,7 +151,7 @@ EXAMPLES
$ chimp init -p ./src/chimp-modules
```

_See code: [src/commands/init.ts](https://github.com/xolvio/chimp/blob/v6.0.0-alpha.0/src/commands/init.ts)_
_See code: [src/commands/init.ts](https://github.com/xolvio/chimp/blob/v0.0.0-development/src/commands/init.ts)_
<!-- commandsstop -->

## Updating jest.config.js after chimp init
Expand Down
2 changes: 1 addition & 1 deletion oclif.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
},
"eject": {
"id": "eject",
"description": "eject from chimp",
"description": "Eject from chimp. While chimp is not a runtime dependency and your project will still run after removing it, ejecting offers a cleaner development environment. While we hope you never need to eject, it is reassuring to know you have the option. If you choose to eject or are considering it, please inform us. Remember, you are always just one command away from this choice.",
"strict": true,
"pluginName": "chimp",
"pluginAlias": "chimp",
Expand Down
3 changes: 2 additions & 1 deletion src/commands/eject.ts
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,8 @@ function moveCode(projectMainPath: string, chimpMainPath: string) {
}

export default class Eject extends Command {
static description = 'eject from chimp';
static description =
'Eject from chimp. While chimp is not a runtime dependency and your project will still run after removing it, ejecting offers a cleaner development environment. While we hope you never need to eject, it is reassuring to know you have the option. If you choose to eject or are considering it, please inform us. Remember, you are always just one command away from this choice.';

static examples = ['$ chimp eject'];

Expand Down

0 comments on commit a1881dd

Please sign in to comment.