readme & license

Author: yyx990803

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018-present, Yuxi (Evan) You
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,5 +1,3 @@
-# !!! WIP !!!
-
 <p align="center">
   <img width="280" src="https://github.com/vuejs/vuepress/blob/master/docs/.vuepress/public/hero.png" alt="logo">
 </p>
@@ -9,3 +7,32 @@
 > Minimalistic docs generator with Vue component based layout system
 
 https://vuepress.vuejs.org/
+
+## Features
+
+- [Built-in markdown extensions](https://vuepress.vuejs.org/guide/markdown.md) optimized for technical documentation
+- [Ability to leverage Vue inside markdown files](https://vuepress.vuejs.org/using-vue.md)
+- [Vue-powered custom theme system](https://vuepress.vuejs.org/custom-themes)
+- PWA Support
+- Google Analytics Integration
+- A default theme with:
+  - Responsive layout
+  - Optional Homepage
+  - Simple out-of-the-box header-based search
+  - Customizable navbar and sidebar
+  - Auto-generated GitHub link and page edit links
+
+## Todo Features
+
+VuePress is still a work in progress. There are a few things that it currently does not support but are planned:
+
+- Dropdown Items in Navbar
+- Multi-Language Support
+- Algolia DocSearch Integration
+- Blogging support
+
+Contributions are welcome!
+
+## License
+
+MIT