docs(seed-icon): update readme

daangn · Feb 13, 2023 · 8e1091d · 8e1091d
1 parent d9322b4
commit 8e1091d
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 6 deletions.
diff --git a/packages/icon/README-en.md b/packages/icon/README-en.md
@@ -0,0 +1,62 @@
+# @seed-design/icon
+
+## Install
+
+The `@seed-design/icon` is a command-line tool for generating seed icons.
+
+```bash
+npm install --dev @seed-design/icon
+
+# or
+
+yarn add -D @seed-design/icon
+```
+
+## How to use
+
+You can create a seed icon with just two commands.
+
+### `init`
+
+The `init` command creates the default folder structure for seed icon creation.
+The `icon.config.yml` configuration file is created when you enter that command.
+
+```bash
+# npm
+npm run seed-icon init
+
+# yarn
+yarn seed-icon init
+```
+
+### `generate`
+
+The `generate` command generates the files required for the generated `icon.config.yml` configuration file icon.
+The files generated are an **icon component** and a **sprite svg file**.
+
+```bash
+# npm
+npm run seed-icon generate
+npm run seed-icon gen
+
+# yarn
+yarn seed-icon generate
+yarn seed-icon gen
+```
+
+### etc
+
+- help
+- version
+
+## config options
+
+The `icon.config.yml` configuration file has the following options
+
+| Option                | Description                                                                             | Default                                                               |
+| --------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `componentOutputPath` | The path where the icon component will be stored. This is relative to the project root. | src                                                                   |
+| `componentFileName`   | The name of the icon component.                                                         | SeedIcon                                                              |
+| `spriteOutputPath`    | The path where the svg file will be saved. Relative to the project root.Image           | assets                                                                |
+| `spriteFileName`      | The name of the svg file.The name of the svg file.                                      | sprite                                                                |
+| `icons`               | Please add the names of the icons used in the above Pygma file.                         | [icon_add_circle_fill, icon_add_circle_regular, icon_add_circle_thin] |
diff --git a/packages/icon/README.md b/packages/icon/README.md
@@ -1,6 +1,6 @@
 # @seed-design/icon
 
-## Install
+## 설치하기
 
 `@seed-design/icon`는 seed icon 생성을 위한 커맨드라인 도구입니다.
 
@@ -12,11 +12,11 @@ npm install --dev @seed-design/icon
 yarn add -D @seed-design/icon
 ```
 
-## how to use
+## 사용 방법
 
 단 두 가지 명령어로 seed icon을 생성할 수 있습니다.
 
-### `init`
+### `init` (초기화)
 
 `init` 명령어는 seed icon 생성을 위한 기본 폴더 구조를 생성합니다.
 해당 명령어를 입력하면 `icon.config.yml` 설정 파일이 생성됩니다.
@@ -29,7 +29,7 @@ npm run seed-icon init
 yarn seed-icon init
 ```
 
-### `generate`
+### `generate` (생성하기)
 
 `generate` 명령어는 생성된 `icon.config.yml` 설정 파일 아이콘에 필요한 파일들을 생성합니다.
 생성되는 파일은 **아이콘 컴포넌트**와 **sprite svg 파일**입니다.
@@ -44,12 +44,12 @@ yarn seed-icon generate
 yarn seed-icon gen
 ```
 
-### etc
+### etc (기타)
 
 - help
 - version
 
-## config options
+## Config 파일 옵션
 
 `icon.config.yml` 설정 파일은 아래와 같은 옵션을 가집니다.