Skip to content

Commit a97dcce

Browse files
committed
docs: update README
1 parent 0105712 commit a97dcce

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ manage .env files for react-native-dotenv
3838

3939
```
4040
USAGE
41-
$ rn-toolbox dotenv [ENVIRONMENTNAME] [-h]
41+
$ rn-toolbox dotenv ENVIRONMENTNAME [-h]
4242
4343
ARGUMENTS
4444
ENVIRONMENTNAME name of the environment to load .dotenv file for
@@ -48,22 +48,25 @@ FLAGS
4848
4949
DESCRIPTION
5050
manage .env files for react-native-dotenv
51-
5251
Manage .env files for react-native-dotenv for a specific environment (development, production, etc...)
52+
53+
54+
EXAMPLES
55+
$ rn-toolbox dotenv
5356
```
5457

55-
_See code: [dist/commands/dotenv.ts](https://github.com/forward-software/react-native-toolbox/blob/v3.0.0/dist/commands/dotenv.ts)_
58+
_See code: [src/commands/dotenv.ts](https://github.com/forwardsoftware/react-native-toolbox/blob/v3.0.0/src/commands/dotenv.ts)_
5659

5760
## `rn-toolbox help [COMMAND]`
5861

5962
Display help for rn-toolbox.
6063

6164
```
6265
USAGE
63-
$ rn-toolbox help [COMMAND] [-n]
66+
$ rn-toolbox help [COMMAND...] [-n]
6467
6568
ARGUMENTS
66-
COMMAND Command to show help for.
69+
COMMAND... Command to show help for.
6770
6871
FLAGS
6972
-n, --nested-commands Include all nested commands in the output.
@@ -72,15 +75,15 @@ DESCRIPTION
7275
Display help for rn-toolbox.
7376
```
7477

75-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_
78+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.25/src/commands/help.ts)_
7679

7780
## `rn-toolbox icons [FILE]`
7881

7982
generate app icons
8083

8184
```
8285
USAGE
83-
$ rn-toolbox icons [FILE] [-h] [-a <value>]
86+
$ rn-toolbox icons [FILE] [-a <value>] [-h]
8487
8588
ARGUMENTS
8689
FILE [default: ./assets/icon.png] input icon file
@@ -91,21 +94,23 @@ FLAGS
9194
9295
DESCRIPTION
9396
generate app icons
94-
9597
Generate app icons using FILE as base.
96-
9798
The base icon file should be at least 1024x1024px.
99+
100+
101+
EXAMPLES
102+
$ rn-toolbox icons
98103
```
99104

100-
_See code: [dist/commands/icons.ts](https://github.com/forward-software/react-native-toolbox/blob/v3.0.0/dist/commands/icons.ts)_
105+
_See code: [src/commands/icons.ts](https://github.com/forwardsoftware/react-native-toolbox/blob/v3.0.0/src/commands/icons.ts)_
101106

102107
## `rn-toolbox splash [FILE]`
103108

104109
generate app splashscreen for react-native-splash-screen
105110

106111
```
107112
USAGE
108-
$ rn-toolbox splash [FILE] [-h] [-a <value>]
113+
$ rn-toolbox splash [FILE] [-a <value>] [-h]
109114
110115
ARGUMENTS
111116
FILE [default: ./assets/splashscreen.png] input splashscreen file
@@ -116,13 +121,15 @@ FLAGS
116121
117122
DESCRIPTION
118123
generate app splashscreen for react-native-splash-screen
119-
120124
Generate app splashscreen using FILE as base to be used with crazycodeboy/react-native-splash-screen module.
121-
122125
The base splashscreen file should be at least 1242x2208px.
126+
127+
128+
EXAMPLES
129+
$ rn-toolbox splash
123130
```
124131

125-
_See code: [dist/commands/splash.ts](https://github.com/forward-software/react-native-toolbox/blob/v3.0.0/dist/commands/splash.ts)_
132+
_See code: [src/commands/splash.ts](https://github.com/forwardsoftware/react-native-toolbox/blob/v3.0.0/src/commands/splash.ts)_
126133
<!-- commandsstop -->
127134

128135
## License

0 commit comments

Comments
 (0)