add readme.rst

.travis.yml

@@ -1,8 +1,16 @@
 language: python
+
 python:
     - "2.7.13"
     - "3.6"
+
 install:
     - pip install tox-travis
     - pip install setuptools==34.3.1
+
 script: tox
+
+notifications:
+  email:
+    on_success: never
+    on_failure: always

Makefile

@@ -1,6 +1,10 @@
-.PHONY: publist debug
+.PHONY: rst publist debug
 
-publish:
+rst:
+	rm README.rst
+	pandoc --from=markdown --to=rst --output=README.rst README.md
+
+publish: rst
 	rm -rf dist/
 	python setup.py sdist bdist_wheel
 	twine upload -s dist/*

README.md

@@ -15,10 +15,7 @@ Have you ever dreamed of a better output of `dir()`? I do. So I created this.
 
   ![](https://github.com/laike9m/pdir2/raw/master/images/search.gif)
 
-
 ## Install
-(NOTE: It's not on pypi yet so now you have to install using setup.py.
- I'll upload it asap.)
 ```
 pip install pdir2
 ```

README.rst

@@ -0,0 +1,55 @@
+pdir2
+=====
+
+Have you ever dreamed of a better output of ``dir()``? I do. So I
+created this.
+
+.. figure:: https://github.com/laike9m/pdir2/raw/master/images/presentation.gif
+   :alt: 
+
+Features
+--------
+
+-  Attributes are grouped by types/functionalities, with beautiful
+   colors.
+
+-  Support all platforms including Windows(Thanks to
+   `colorama <https://github.com/tartley/colorama>`__).
+
+-  The return value of ``pdir()`` can still be used as a list of names.
+
+-  You can search for certain names with ``.s()`` or ``.search()``:
+
+.. figure:: https://github.com/laike9m/pdir2/raw/master/images/search.gif
+   :alt: 
+
+Install
+-------
+
+(NOTE: It's not on pypi yet so now you have to install using setup.py.
+I'll upload it asap.)
+
+::
+
+    pip install pdir2
+
+About the name. I wanted to call it ``pdir``, but there's already one
+with this name on pypi. Mine is better, of course.
+
+Testing
+-------
+
+Simply run ``pytest``, or use ``tox`` if you like.
+
+Roadmap
+-------
+
+-  [ ] config color
+-  [ ] colorful docstring
+
+|Build Status| |Supported Python versions|
+
+.. |Build Status| image:: https://travis-ci.org/laike9m/pdir2.svg
+   :target: https://travis-ci.org/laike9m/pdir2
+.. |Supported Python versions| image:: https://img.shields.io/pypi/pyversions/pdir2.svg
+   :target: https://pypi.python.org/pypi/pdir2/

setup.cfg

@@ -0,0 +1,2 @@
+[wheel]
+universal = 1

setup.py

@@ -1,9 +1,13 @@
+import codecs
 from setuptools import setup
 
+readme = codecs.open('README.rst', encoding='utf-8').read()
+
 setup(
     name='pdir2',
-    version='0.0.1',
+    version='0.0.1.post2',
     description='Pretty dir printing with joy',
+    long_description=readme,
     author='laike9m',
     author_email='laike9m@gmail.com',
     url='http://github.com/laike9m/pdir2',
@@ -14,6 +18,9 @@
         'colorama',
         'enum34;python_version<"3.4"',
     ],
+    package_data={'': ['LICENSE', 'README.rst']},
+    include_package_data=True,
+    license='MIT License',
     classifiers=[
         'Intended Audience :: Developers',
         'License :: OSI Approved :: MIT License',