From 58dd714cefa35d08adaed28ae075587bd776a761 Mon Sep 17 00:00:00 2001
From: c-bata <contact@c-bata.link>
Date: Sat, 24 Oct 2020 18:53:42 +0900
Subject: [PATCH] Update README

---
 LICENSE     | 21 +++++++++++++++++++++
 MANIFEST.in |  1 +
 README.md   | 49 +++++++++++++++++++++++++++++++++++++++++++++++--
 3 files changed, 69 insertions(+), 2 deletions(-)
 create mode 100644 LICENSE
 create mode 100644 MANIFEST.in

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 00000000..b1b3f98c
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Masashi SHIBATA
+
+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.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 00000000..1aba38f6
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1 @@
+include LICENSE
diff --git a/README.md b/README.md
index 5383f285..1b08e10e 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,49 @@
 # optuna-dashboard
 
-Web dashboard for Optuna.
-TypeScript files originally taken from [Goptuna's dashboard](https://github.com/c-bata/goptuna).
+Realtime Web dashboard for Optuna. Code files were originally taken from [Goptuna](https://github.com/c-bata/goptuna).
+
+![demo](https://user-images.githubusercontent.com/5564044/97078684-ba98a180-1628-11eb-8245-7cb8c76647f5.gif)
+
+## Usage
+
+You can install optuna-dashboard via pip.
+
+```console
+$ pip install optuna-dashboard
+```
+
+After you installed, `optuna-dashboard` command is available.
+Please execute it with Optuna storage URL.
+
+```
+$ optuna-dashboard sqlite:///db.sqlite3
+Bottle v0.12.18 server starting up (using WSGIRefServer())...
+Listening on http://localhost:8080/
+Hit Ctrl-C to quit.
+```
+
+<details>
+
+<summary>More command line options</summary>
+
+```
+$ optuna-dashboard --help
+usage: optuna-dashboard [-h] [--port PORT] [--host HOST] [--quiet] storage
+
+A third-party dashboard for optuna.
+
+positional arguments:
+  storage      Optuna Storage URL
+
+optional arguments:
+  -h, --help   show this help message and exit
+  --port PORT  port number (default: 8080)
+  --host HOST  hostname (default: 'localhost')
+  --quiet      quiet
+```
+
+</details>
+
+## Alternatives
+
+* [optdash](https://github.com/ytsmiling/optdash): a third-party dashboard for optuna.