Skip to content

Commit a89ddff

Browse files
committed
docs: update the README.md
1 parent f84cc77 commit a89ddff

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,3 +113,15 @@ describe('test', () => {
113113
// good
114114
test('test', () => {});
115115
```
116+
117+
- Api, commands and config in README.md should be ordered alphabetically.
118+
119+
```ts
120+
// bad
121+
- `tnf foo`
122+
- `tnf bar`
123+
124+
// good
125+
- `tnf bar`
126+
- `tnf foo`
127+
```

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ $ pnpm preview
5151
## Commands
5252

5353
- `tnf build`: Build the project.
54+
- `tnf config list/get/set/remove [name] [value]`: Manage the config.
5455
- `tnf dev`: Start the development server.
5556
- `tnf generate/g <type> <name>`: Generate a new page (or component and other types in the future).
5657
- `tnf preview`: Preview the product after building the project.
5758
- `tnf sync --mode=<mode>`: Sync the project to the temporary directory.
58-
- `tnf config [ list | get | set | remove ] [name] [value]`: Quickly view and modify configurations through the command line.
5959

6060
## API
6161

src/config/config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ export async function setConfig({
138138
},
139139
});
140140
}
141+
141142
export async function config({ context }: { context: Context }) {
142143
const { _ } = context.argv;
143144
const [, command, name, value] = _;

0 commit comments

Comments
 (0)