Rewrite README in markdown

Signed-off-by: wujiawei <wujiawei@xiaomi.com>
einverne · Aug 3, 2017 · c89787c · c89787c
1 parent a51ca3e
commit c89787c
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,34 @@
+douban downloader
+=======================
+
+A simple python script to download douban albums and celebrity
+
+
+Installation
+------------
+
+    $ pip install douban-dl
+
+
+Usage
+-----
+
+    $ douban-dl url [path]
+
+`url` should be like this:
+
+    https://www.douban.com/photos/album/<album_id>
+    https://movie.douban.com/celebrity/<celebrity_id>
+
+`path` is the folder where images saved, defaults to `./douban`.
+
+License
+-------
+
+MIT
+
+
+Contribute
+----------
+
+Feel free to file an issue, or make a pr.
diff --git a/setup.cfg b/setup.cfg
@@ -1,2 +1,5 @@
 [bdist_wheel]
 universal = 1
+
+[metadata]
+description-file = README.md