From 5eb089863c28154cc6fd6acc9cc87fe71deb0e46 Mon Sep 17 00:00:00 2001
From: Alex Ling <hkalexling@gmail.com>
Date: Mon, 17 Feb 2020 03:32:11 +0000
Subject: [PATCH] - README

---
 README.md | 42 ++++++++++++++++++++++++++++++++++++------
 1 file changed, 36 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 140a971..f6481ec 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,48 @@
-# mango
+# Mango
 
-TODO: Write a description here
+Mango is a self-hosted Manga Server and Reader. Its features include
+
+- Multi-user support
+- Supports both `.zip` and `.cbz` formats
+- Automatically store reading progress
+- The web reader is responsive and works well on mobile, so there is no need for a mobile app
+- All the static files are embedded in the binary, so the deployment process is easy and painless
 
 ## Installation
 
-TODO: Write installation instructions here
+### Build from source
+
+1. Make sure you have Crystal (0.32.0), Node and Yarn installed
+2. Clone the repository
+3. Run `make`
+4. Move the compiled executable to your desire location and run it
 
 ## Usage
 
-TODO: Write usage instructions here
+### CLI
 
-## Development
+```
+Mango e-manga server/reader. Version 0.1.0
 
-TODO: Write development instructions here
+    -v, --version                    Show version
+    -h, --help                       Show help
+    -c PATH, --config=PATH           Path to the config file. Default is `~/.config/mango/config.yml`
+```
+
+### Config
+
+The default config file location is `~/.config/mango/config.yml`. The config options and default values are given below
+
+```yaml
+---
+port: 9000
+library_path: ~/mango/library
+db_path: ~/mango/mango.db
+scan_interval_minutes: 5
+log_level: info
+```
+
+## Screenshots
 
 ## Contributing