add docs

.gitignore

@@ -5,4 +5,5 @@ node_modules
 build
 dist
 .env
-.idea
+.idea
+.DS_Store

README.md

@@ -1,4 +1,23 @@
-## CVPM - Computer Vision Package Manager
+# CVPM - Computer Vision Package Manager
 
 ![CVPM](https://img.shields.io/github/license/mashape/apistatus.svg)
 [![Go Report Card](https://goreportcard.com/badge/github.com/unarxiv/cvpm)](https://goreportcard.com/report/github.com/unarxiv/cvpm)
+[![Build Status](https://travis-ci.org/unarxiv/CVPM.svg?branch=master)](https://travis-ci.org/unarxiv/CVPM)
+
+## Documentation
+
+Full documentation can be found [here](https://cvpm.autoai.org).
+
+## Contributing
+
+If you found a security bugs, please do not post it in issues or any other public forum. You can send me [email](mailto:xiaozhe.yaoi@qq.com) directly.
+
+## Affiliated Project
+
+This project is inspired from [CVTron](https://docs.cvtron.org).
+
+## FAQs
+
+Q: Where can I find useful models?
+
+A: There are three places. The first one, which is we recommend most, is our [model hub](https://hub.autoai.org), where you can download, purchase, search models. The second one is GitHub, in GiHub, you can search for CVPM_Available in readme file, which indicates that repository is compatible with CVPM. The third one is our [forum](https://forum.cvtron.xyz), where you can discuss performance of models, and ask for others models.

docs/.vuepress/config.js

@@ -60,7 +60,7 @@ module.exports = {
             }
           ],
           sidebar: {
-            '/guide/': genSidebarConfig('Guide')
+            '/en-US/guide/': genSidebarConfig('Guide')
           }
         },
         '/zh-CN/': {
@@ -108,6 +108,8 @@ module.exports = {
         title,
         collapsable: true,
         children: [
+          '',
+          'getting-started',
         ]
       }
     ]

docs/README.md

@@ -1,6 +1,6 @@
 ---
 home: true
-heroImage: /logo.svg
+heroImage: /logo.png
 actionText: Get Started →
 actionLink: /en-US/guide/
 features:

docs/en-US/guide/README.md

@@ -0,0 +1,3 @@
+# Introduction
+
+# Welcome

docs/en-US/guide/getting-started.md

@@ -0,0 +1,36 @@
+# Getting Started
+
+## Prerequisite
+
+CVPM requires Python 3 and Pip. Before your installation, please make sure you have both in your system.
+
+You can download Python 3 from [here](https://www.python.org/).
+
+## Automatically Installation
+
+## Manually Installation
+
+### Download Executable Binary File
+
+Go to our [release page](https://github.com/unarxiv/CVPM/releases) to download latest binary file.
+
+Place the binary into your ```PATH```.
+
+If your Python and Pip command are not in your ```PATH```, RUN ```cvpm config``` to set your python and pip location.
+
+### Install CVPM Python Dependency
+
+RUN ```cvpm install cvpm:stable``` or ```cvpm install cvpm:test```. It helps you to install cvpm python dependency into your system.
+
+### Install Packages
+
+RUN ```cvpm install vendor/repo``` to install a package from [model hub](https://hub.autoai.org).
+
+Or, RUN ```cvpm install https://github.com/vendor/repo``` to install a package from GitHub. Make sure the repo you are going to install is CVPM Available.
+
+### Run it!
+
+Before you run any of your installed repo, a daemon process must be enabled. Note that you only need to enable it once by running 
+```cvpm daemon install```. It may requires you administrator permission to install on most systems.
+
+Some repos may have more than one solver in it, therefore, you have to know the exact solver name to run. By running ```cvpm run vendor/repo/solver```, you can start a service.

docs/zh-CN/README.md

@@ -1,8 +1,8 @@
 ---
 home: true
-heroImage: https://i.loli.net/2018/04/20/5ad9fa0eefc5a.png
-actionText: Get Started →
-actionLink: /en-US/guide/
+heroImage: /logo.png
+actionText: 快速上手 →
+actionLink: /zh-CN/guide/
 features:
 - title: User Friendly
   details: It is smaller and less complex than some other computer vision libraries. It provide an easy-to-use user interface to interacts with.
@@ -11,4 +11,20 @@ features:
 - title: Commercial Ready
   details: Feel free to use it in your commercial product. Some companies have tested it in production environment already. We are also providing consulting service.
 footer: MIT Licensed | Copyright © 2018-Present UnArxiv Foundation
----
+---
+### As Easy as 1, 2, 3
+
+``` bash
+# install
+curl xxx # OR npm install -g vuepress
+
+# Download Computer Vision Package
+cvpm install xzyaoi/Face_Utility # OR cvpm install https://github.com/xzyaoi/Face_Utility
+
+# start writing
+cvpm repo run xzyaoi/Face_Utility/Face_Detection
+```
+
+::: warning COMPATIBILITY NOTE
+CVPM requires Python >= 3.5
+:::

docs/zh-CN/guide/README.md

@@ -0,0 +1,3 @@
+# Introduction
+
+# Welcome

docs/zh-CN/guide/getting-started.md

@@ -0,0 +1 @@
+# 快速上手