From e9d5c98b6d726bd64251bd95cfd266989244503b Mon Sep 17 00:00:00 2001
From: mashirozx <moezhx@outlook.com>
Date: Sat, 10 Jul 2021 19:47:40 +0800
Subject: [PATCH] Update readme

---
 README.md        | 56 ++++++++++++++++++++----------------------------
 docs/composer.md |  8 +++++++
 2 files changed, 31 insertions(+), 33 deletions(-)
 create mode 100644 docs/composer.md

diff --git a/README.md b/README.md
index 147e3c0..386c6e9 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,26 @@
-# Vue 3 + Typescript + Vite
+# sakura-next
 
-```bash
-wget https://getcomposer.org/installer -O composer.phar
-php composer.phar
-mv composer.phar /usr/local/bin/composer
-composer.phar install
+## Requirement
 
-curl -sS https://getcomposer.org/installer | php
+- PHP=7.4
+- WordPress>=5.6.0
+- Node.js>=14.17.1
+- yarn>=1.22.10
+
+## Commands
+
+```sh
+composer install # install php dependencies
+yarn install # install node dependencies
+yarn dev # run dev server
+yarn build # build assets
+yarn test # Jest test
+yarn lint # eslint
+yarn format # auto format
+yarn i18n # export i18n variables
+yarn rsync # sync backend app with server, see docs/dev.md
+yarn composer # run `composer install` on remote server
+yarn gen:icon # generate svg icon component
+yarn remote-download:geoip2 # download GeoIP db on remote server
+yarn local-download:geoip2 # download GeoIP db locally
 ```
-
-This template should help get you started developing with Vue 3 and Typescript in Vite.
-
-## Recommended IDE Setup
-
-[VSCode](https://code.visualstudio.com/) + [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur). Make sure to enable `vetur.experimental.templateInterpolationService` in settings!
-
-### If Using `<script setup>`
-
-[`<script setup>`](https://github.com/vuejs/rfcs/pull/227) is a feature that is currently in RFC stage. To get proper IDE support for the syntax, use [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) instead of Vetur (and disable Vetur).
-
-## Type Support For `.vue` Imports in TS
-
-Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can use the following:
-
-### If Using Volar
-
-Run `Volar: Switch TS Plugin on/off` from VSCode command palette.
-
-### If Using Vetur
-
-1. Install and add `@vuedx/typescript-plugin-vue` to the [plugins section](https://www.typescriptlang.org/tsconfig#plugins) in `tsconfig.json`
-2. Delete `src/shims-vue.d.ts` as it is no longer needed to provide module info to Typescript
-3. Open `src/main.ts` in VSCode
-4. Open the VSCode command palette
-5. Search and run "Select TypeScript version" -> "Use workspace version"
diff --git a/docs/composer.md b/docs/composer.md
new file mode 100644
index 0000000..23c118a
--- /dev/null
+++ b/docs/composer.md
@@ -0,0 +1,8 @@
+```bash
+wget https://getcomposer.org/installer -O composer.phar
+php composer.phar
+mv composer.phar /usr/local/bin/composer
+composer.phar install
+
+curl -sS https://getcomposer.org/installer | php
+```