faker-js · xDivisionByZerox · Dec 20, 2023 · Dec 18, 2023 · Dec 18, 2023 · Dec 18, 2023
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 A CLI of [@faker-js/faker](https://github.com/faker-js/faker).
 
-> **Note**: This is currently a [MVP](https://en.wikipedia.org/wiki/Minimum_viable_product).
+> **:information_source: Note**: This is currently a [MVP](https://en.wikipedia.org/wiki/Minimum_viable_product).
 
 ## Install
 
@@ -13,27 +13,57 @@ npm install --save-dev @faker-js/cli
 ## Usage
 
 ```
-faker module_name method_name
+npx faker <moduleName> <functionName>
 ```
 
-Faker-CLI expects a `module_name` as well as a `method_name` depending on the module chosen.
+> **:information_source: Note**: [Read more about `npx`](https://docs.npmjs.com/cli/v7/commands/npx)
 
-To list all possible modules run:
+Faker-CLI expects a `moduleName` as well as a `functionName` argument.
+This is equivalent to calling `faker[moduleName][functionName]`.
+Checkout [Fakers's API](https://fakerjs.dev/api/) for information on which modules and functions are available.
 
-```bash
-faker --help
-```
+## Examples
 
-To list all possible methods of a module run:
+If you want a integer you can run:
 
 ```bash
-faker module_name --help
+npx faker number int
 ```
 
 ## Whats next
 
 Upcoming features might include:
 
-- localization
-- support for all parameters `@faker-js/faker` natively
-- make the CLI consumable for your own modules
+### :hammer_and_wrench: Localization
+
+You should be able to provide a specific locale for localized data.
+Currently, the CLI will always use the default `en` locale.
+This feature could look like this:
+
+```bash
+npx faker --locale de person firstName
+```
+
+This example would print a first name of the German locale.
+
+### :hammer_and_wrench: Support for All Parameters of `@faker-js/faker` Natively
+
+This CLI is an MVP, currently.
+This means that it does the bare minimum.
+If you want an integer in a specific range, you are on your own.
+
+In the future such a feature could look like this:
+
+```bash
+npx faker number int --min 10 --max 20
+```
+
+This example will print an integer between 10 and 20.
+`min` and `max` are options that are available in [Faker's int options](https://fakerjs.dev/api/number.html#int).
+
+### :hammer_and_wrench: Better Documentation in the Terminal
+
+Developers usually hate to switch work environments.
+If you are already working in the terminal, you likely don't want to leave to check what to look up a little detail.
+Instead you expect the CLI to have a proper `--help` documentation, including examples.
+In the future, this should be the case.
diff --git a/src/commands/airline/aircraftType.ts b/src/commands/airline/aircraftType.ts
diff --git a/src/commands/airline/airline.ts b/src/commands/airline/airline.ts
diff --git a/src/commands/airline/airplane.ts b/src/commands/airline/airplane.ts
diff --git a/src/commands/airline/airport.ts b/src/commands/airline/airport.ts
diff --git a/src/commands/airline/flightNumber.ts b/src/commands/airline/flightNumber.ts
diff --git a/src/commands/airline/index.ts b/src/commands/airline/index.ts
diff --git a/src/commands/airline/recordLocator.ts b/src/commands/airline/recordLocator.ts
diff --git a/src/commands/airline/seat.ts b/src/commands/airline/seat.ts
diff --git a/src/commands/animal/bear.ts b/src/commands/animal/bear.ts
diff --git a/src/commands/animal/bird.ts b/src/commands/animal/bird.ts
diff --git a/src/commands/animal/cat.ts b/src/commands/animal/cat.ts
diff --git a/src/commands/animal/cetacean.ts b/src/commands/animal/cetacean.ts
diff --git a/src/commands/animal/cow.ts b/src/commands/animal/cow.ts
diff --git a/src/commands/animal/crocodilia.ts b/src/commands/animal/crocodilia.ts
diff --git a/src/commands/animal/dog.ts b/src/commands/animal/dog.ts
diff --git a/src/commands/animal/fish.ts b/src/commands/animal/fish.ts
diff --git a/src/commands/animal/horse.ts b/src/commands/animal/horse.ts
diff --git a/src/commands/animal/index.ts b/src/commands/animal/index.ts
diff --git a/src/commands/animal/insect.ts b/src/commands/animal/insect.ts
diff --git a/src/commands/animal/lion.ts b/src/commands/animal/lion.ts
diff --git a/src/commands/animal/rabbit.ts b/src/commands/animal/rabbit.ts
diff --git a/src/commands/animal/rodent.ts b/src/commands/animal/rodent.ts
diff --git a/src/commands/animal/snake.ts b/src/commands/animal/snake.ts
diff --git a/src/commands/animal/type.ts b/src/commands/animal/type.ts
diff --git a/src/commands/color/cmyk.ts b/src/commands/color/cmyk.ts
diff --git a/src/commands/color/colorByCSSColorSpace.ts b/src/commands/color/colorByCSSColorSpace.ts