Skip to content

Commit f4b8018

Browse files
committed
update docs
1 parent cc9306c commit f4b8018

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# :toolbox: Intlify CLI
1+
# 🧰 Intlify CLI
22

33
CLI Tooling for i18n development
44

5-
## :cd: Installation
5+
## 💿 Installation
66

77
### npm
88

@@ -15,38 +15,49 @@ npm install -g @intlify/cli
1515
yarn global add @intlify/cli
1616
```
1717

18+
### yarn
19+
```sh
20+
yarn global add @intlify/cli
21+
```
22+
23+
## 🌟 Features
24+
- the i18n resources compilation
25+
- the attributes annotation for i18n custom block
26+
- the i18n custom block formatting
1827

19-
## :rocket: Usage
28+
## 🚀 Usage
2029

2130
```
2231
Usage: intlify <command> [options]
2332
2433
Commands:
25-
intlify compile compile the i18n resources [aliases: cp]
34+
intlify compile compile the i18n resources [aliases: cp]
35+
intlify annotate annotate the attributes [aliases: at]
36+
intlify format format for single-file components [aliases: ft]
2637
2738
Options:
2839
--help Show help [boolean]
2940
--version Show version number [boolean]
3041
```
3142

32-
## :handshake: API
43+
## 🤝 API
3344

3445
About details, See the [API References](https://github.com/intlify/cli/blob/main/api.md)
3546

3647

37-
## :globe_with_meridians: I18n
48+
## 🌏 I18n
3849

3950
Intlify cli is supporting for I18n.
4051

4152
If you would like to localiize Intlify CLI, you can contribute i18n resource to [locales](https://github.com/intlify/cli/blob/main/locales) directory.
4253

43-
## :scroll: Changelog
54+
## 📜 Changelog
4455
Details changes for each release are documented in the [CHANGELOG.md](https://github.com/intlify/cli/blob/main/CHANGELOG.md).
4556

4657

47-
## :exclamation: Issues
58+
## Issues
4859
Please make sure to read the [Issue Reporting Checklist](https://github.com/intlify/cli/blob/main/.github/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
4960

50-
## :copyright: License
61+
## ©️ License
5162

5263
[MIT](http://opensource.org/licenses/MIT)

0 commit comments

Comments
 (0)