!1 Merge back to master

Merge pull request !1 from dev branch

README.md

@@ -1,2 +1,69 @@
-# share-heap
-A simple file sharing server.
+<h1 align="center">
+  Quickshare
+</h1>
+<p align="center">
+  A succinct file sharing server
+</p>
+<p align="center">
+  <a href="https://gitter.im/quickshare/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link">
+    <img src="https://badges.gitter.im/Join%20Chat.svg" />
+  </a>
+<p>
+
+![Quickshare demo](./demo.jpg)
+
+Choose Language: English | [简体中文](./docs/README_zh-cn.md)
+
+## Download
+
+| Linux        | Mac          | Windows      |
+| ------------ | ------------ | ------------ |
+| [Download]() | [Download]() | [Download]() |
+
+## Features
+
+* Upload and download in browser, no client
+* Share files among desktop and mobile devices
+* Portable software
+* Add files from local
+* Add download limit for resource
+* Download from interrupted point
+
+## Installation
+
+2 steps are needed to start a quickshare: unzip it and start it.
+
+The first step, unzip and start quickshare
+
+### Linux
+
+* Unzip the package: `unzip [package].` (`[package]` could be `quickshare_0.0.8_linux_x86_6 4.zip`)
+* Start quickshare `./quickshare`
+
+### Mac
+
+* Unzip the package: `unzip [package].` (`[package]` could be `quickshare_0.0.8_macos_x86_64.zip`)
+* Start quickshare `./quickshare`
+
+### Windows
+
+* Unzip the package
+* Go into folder and click `quickshare.exe`
+
+Last step, meet quickshare in browser
+
+* Quickshare will start and show `quickshare starts @ [URL]` in terminal (e.g. `URL` could be `192.168.0.1:8888`)
+* Open `URL` in browser and login with `admin` and `quicksh@re`
+* Enjoy (But don't forget to change password according to [FAQ document](./docs/FAQ_en-us.md))
+
+### FAQ
+
+Please refer [FAQ document](./docs/FAQ_en-us.md)
+
+### Configuration
+
+Please refer [Configuration document](./docs/CONFIG_en-us.md)
+
+### Contribution
+
+Will add it soon...