From bbb1398ca9d90675bc43c614443f78d5b6d179da Mon Sep 17 00:00:00 2001
From: lgandecki <gozdak@gmail.com>
Date: Tue, 22 Aug 2023 15:31:24 +0200
Subject: [PATCH] docs: updated readme

---
 README.md             | 32 ++++++++++++++++++++++++++++----
 oclif.manifest.json   |  2 +-
 src/commands/eject.ts |  3 ++-
 3 files changed, 31 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 0451511..e041e91 100644
--- a/README.md
+++ b/README.md
@@ -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
@@ -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)
@@ -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`
 
@@ -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]`
 
@@ -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
diff --git a/oclif.manifest.json b/oclif.manifest.json
index 09bca48..72cb60d 100644
--- a/oclif.manifest.json
+++ b/oclif.manifest.json
@@ -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",
diff --git a/src/commands/eject.ts b/src/commands/eject.ts
index 39da2d6..ef7d23c 100644
--- a/src/commands/eject.ts
+++ b/src/commands/eject.ts
@@ -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'];