chore: updating typegen README (#1561)

FuelLabs · Dec 19, 2023 · 137ed8a · 137ed8a
1 parent 1690004
commit 137ed8a
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 15 deletions.
diff --git a/.changeset/good-timers-cry.md b/.changeset/good-timers-cry.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md b/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md
@@ -17,15 +17,16 @@ $ pnpm fuels typegen -h
 
 Usage: fuels typegen [options]
 
-generate typescript from contract abi json files
+Generate Typescript from Sway ABI JSON files
 
 Options:
-  -i, --inputs <path|glob... input paths/globals to your ABI JSON files
-  -o, --output <dir>           directory path for generated files
-  -c, --contract               generate code for contracts [default]
-  -s, --script                 generate code for scripts
-  --silent                     omit output messages
-  -h, --help                   display help for command
+  -i, --inputs <path|glob...>  Input paths/globals to your ABI JSON files
+  -o, --output <dir>           Directory path for generated files
+  -c, --contract               Generate types for Contracts [default]
+  -s, --script                 Generate types for Scripts
+  -p, --predicate              Generate types for Predicates
+  -S, --silent                 Omit output messages
+  -h, --help                   Display help
 ```
 
 ## Generating Types for Contracts

diff --git a/packages/abi-typegen/README.md b/packages/abi-typegen/README.md
@@ -24,23 +24,26 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/abi-typeg
 ```sh
 pnpm add @fuel-ts/abi-typegen
 # or
-nppnpmm add @fuel-ts/abi-typegen
+npm add @fuel-ts/abi-typegen
 ```
 
 ## Help
 
 ```console
 $ fuels-typegen -h
-Usage: fuels-typegen [options]
 
-generate typescript from contract abi json files
+Generate Typescript from Sway ABI JSON files
+
+Usage: fuels-typegen [options]
 
 Options:
-  -i, --inputs <path|glob...>  input paths/globals to your ABI JSON files
-  -o, --output <dir>           directory path for generated files
-  -c, --contract               generate types for contracts [default]
-  -s, --script                 generate types for scripts
-  --silent                     omit output messages
+  -V, --version                output the version number
+  -i, --inputs <path|glob...>  Input paths/globals to your ABI JSON files
+  -o, --output <dir>           Directory path for generated files
+  -c, --contract               Generate types for Contracts [default]
+  -s, --script                 Generate types for Scripts
+  -p, --predicate              Generate types for Predicates
+  -S, --silent                 Omit output messages
   -h, --help                   display help for command
 ```