docs: add content to readme (#130)

* docs: add readme content * docs: refactor the code * docs: add img * docs: update node version request in bug issue template
svrxjs · Oct 24, 2019 · a8fc920 · a8fc920
1 parent 166423d
commit a8fc920
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 3 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -25,8 +25,9 @@ If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
  - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+ - Node: [e.g. 10.0.0, 12.0.0]
+ - Browser: [e.g. chrome, safari]
+ - Version: [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.
diff --git a/README.md b/README.md
@@ -13,4 +13,43 @@
 
 svrx(server-x) is a platform built for efficient front-end development.
 
-See our [website](https://svrx.io/) for more information.
+## Features
+
+🍻  **Serve** a static site or SPA in current directory               
+🐱 Easy to **proxy** everything             
+🏈   **Auto refresh** the page on sources change(inline reload on stylesheets change)             
+🍀   **Powerful plugins**: use without installation               
+🐥   **Routing with hot reload**: never restart your server               
+🚀   **Toolkit** for quick plugin development             
+🎊  ...
+
+## Quick Start
+
+```bash
+npm install -g @svrx/cli
+mkdir example && cd example
+echo '<html><body>Hello svrx!</body></html>' > index.html
+svrx
+```
+
+![](https://svrx.io/assets/demo.png)
+
+## Documentation
+
+You can read documentation [here](https://docs.svrx.io/en/).
+
+你可以在 [这里](https://docs.svrx.io/zh/) 阅读使用文档。
+
+## Support
+
+Feel free to [raise an issue](https://github.com/svrxjs/svrx/issues/new/choose).
+
+## Contributing
+
+Please see the [contributing guidelines](https://docs.svrx.io/en/contribution.html).
+
+## Providing a new plugin
+
+For contributors planning to write a new plugin, please see the [plugin development guide](https://docs.svrx.io/en/plugin/contribution.html).
+
+[👉 See all plugins](https://svrx.io/plugin?query=svrx-plugin-)