docs: update README

xianshenglu · Nov 10, 2020 · 3ca4324 · 3ca4324
1 parent ecd3e05
commit 3ca4324
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 0 deletions.
diff --git a/README.MD b/README.MD
@@ -0,0 +1,37 @@
+# yapi-to-code
+
+A chrome extension to generate code for [yApi](https://github.com/YMFE/yapi).
+
+## Usage
+
+![](./images/getApiCode.png)
+
+![](./images/optionsPage.png)
+
+## Install
+
+~~install by [chrome extension]()~~
+
+Or
+
+1. clone the project
+
+```bash
+git clone https://github.com/xianshenglu/yapi-to-code.git
+```
+
+2. Click the `Load unpacked` button in `chrome:https://extensions/` page.
+
+![](./images/loadUnpacked.png)
+
+3. Click the `detail` button
+
+![](./images/extensionPage.png)
+
+1. Scroll to bottom and click the `Extension options`
+
+![](./images/detailPage.png)
+
+1. Configure the required fields Or you can configure it later after you get the generated code.
+2. Go back to your yApi site and reload!
+3. Operate like [Usage](#usage) and go back to step 5 if you want.
diff --git a/images/detailPage.png b/images/detailPage.png
diff --git a/images/extensionPage.png b/images/extensionPage.png
diff --git a/images/getApiCode.png b/images/getApiCode.png
diff --git a/images/loadUnpacked.png b/images/loadUnpacked.png
diff --git a/images/optionsPage.png b/images/optionsPage.png