diff --git a/README.md b/README.md new file mode 100644 index 0000000..2a74900 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# pydu + +[![pydu](https://img.shields.io/pypi/v/pydu.svg)](https://pypi.python.org/pypi/pydu) + +[![pydu](https://img.shields.io/pypi/l/pydu.svg)](https://pypi.python.org/pypi/pydu) + +[![pydu](https://img.shields.io/pypi/pyversions/pydu.svg)](https://pypi.python.org/pypi/pydu) + +[![pydu](https://img.shields.io/travis/flaggo/pydu/master.svg?label=Linux)](https://travis-ci.org/flaggo/pydu) + +[![pydu](https://img.shields.io/appveyor/ci/flaggo/pydu/master.svg?label=Windows)](https://ci.appveyor.com/project/flaggo/pydu) + +[![pydu](https://codecov.io/github/flaggo/pydu/coverage.svg?branch=master)](https://codecov.io/github/flaggo/pydu) + +[![pydu](https://img.shields.io/github/contributors/flaggo/pydu.svg)](https://github.com/flaggo/pydu/graphs/contributors) + +**pydu** (python data structures and utils) is a library of useful data structures and utils +for Python 2 and 3, which collected from open source projects and created by contributors. + + +## Installation + +To install pydu, simply: + +```bash +$ pip install pydu +``` + +## Document + +Fantastic documentation is available at: [English](https://flaggo.github.io/pydu/) | [中文版](https://flaggo.github.io/pydu/#/zh-cn/). diff --git a/README.rst b/README.rst deleted file mode 100644 index 8d4cf69..0000000 --- a/README.rst +++ /dev/null @@ -1,41 +0,0 @@ -pydu -==== - -.. image:: https://img.shields.io/pypi/v/pydu.svg - :target: https://pypi.python.org/pypi/pydu - -.. image:: https://img.shields.io/pypi/l/pydu.svg - :target: https://pypi.python.org/pypi/pydu - -.. image:: https://img.shields.io/pypi/pyversions/pydu.svg - :target: https://pypi.python.org/pypi/pydu - -.. image:: https://img.shields.io/travis/flaggo/pydu/master.svg?label=Linux - :target: https://travis-ci.org/flaggo/pydu - -.. image:: https://img.shields.io/appveyor/ci/flaggo/pydu/master.svg?label=Windows - :target: https://ci.appveyor.com/project/flaggo/pydu - -.. image:: https://codecov.io/github/flaggo/pydu/coverage.svg?branch=master - :target: https://codecov.io/github/flaggo/pydu - :alt: codecov.io - -.. image:: https://img.shields.io/github/contributors/flaggo/pydu.svg - :target: https://github.com/flaggo/pydu/graphs/contributors - -**pydu** (python data structures and utils) is a library of useful data structures and utils -for Python 2 and 3, which collected from open source projects and created by contributors. - - -Installation ------------- -To install pydu, simply: - -.. code-block:: bash - - $ pip install pydu - - -Document --------- -Fantastic documentation is available at: `English `_ | `中文版 `_.