Switched docs to md

Lobosque · Lobosque · commit 769346b688a4 · 2016-11-16T19:06:21.000-02:00
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -1,13 +1,9 @@
-=======
-Credits
-=======
+# Credits
 
-Development Lead
-----------------
+## Development Lead
 
 * Lucas Lobosque <lucas.lobosque@contentools.com>
 
-Contributors
-------------
+## Contributors
 
 None yet. Why not be the first?
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,19 +1,13 @@
-.. highlight:: shell
-
-============
-Contributing
-============
+# Contributing
 
 Contributions are welcome, and they are greatly appreciated! Every
 little bit helps, and credit will always be given.
 
 You can contribute in many ways:
 
-Types of Contributions
-----------------------
+## Types of Contributions
 
-Report Bugs
-~~~~~~~~~~~
+### Report Bugs
 
 Report bugs at https://github.com/Lobosque/python_wpapi/issues.
 
@@ -23,27 +17,23 @@ If you are reporting a bug, please include:
 * Any details about your local setup that might be helpful in troubleshooting.
 * Detailed steps to reproduce the bug.
 
-Fix Bugs
-~~~~~~~~
+### Fix Bugs
 
 Look through the GitHub issues for bugs. Anything tagged with "bug"
 and "help wanted" is open to whoever wants to implement it.
 
-Implement Features
-~~~~~~~~~~~~~~~~~~
+### Implement Features
 
 Look through the GitHub issues for features. Anything tagged with "enhancement"
 and "help wanted" is open to whoever wants to implement it.
 
-Write Documentation
-~~~~~~~~~~~~~~~~~~~
+### Write Documentation
 
 Python Wordpress API could always use more documentation, whether as part of the
 official Python Wordpress API docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
-Submit Feedback
-~~~~~~~~~~~~~~~
+### Submit Feedback
 
 The best way to send feedback is to file an issue at https://github.com/Lobosque/python_wpapi/issues.
 
@@ -54,46 +44,54 @@ If you are proposing a feature:
 * Remember that this is a volunteer-driven project, and that contributions
   are welcome :)
 
-Get Started!
-------------
+## Get Started!
 
 Ready to contribute? Here's how to set up `python_wpapi` for local development.
 
 1. Fork the `python_wpapi` repo on GitHub.
-2. Clone your fork locally::
+2. Clone your fork locally:
 
+    ```
     $ git clone git@github.com:your_name_here/python_wpapi.git
+    ```
 
 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
 
+    ```
     $ mkvirtualenv python_wpapi
     $ cd python_wpapi/
     $ python setup.py develop
+    ```
 
 4. Create a branch for local development::
 
+    ```
     $ git checkout -b name-of-your-bugfix-or-feature
+    ```
 
    Now you can make your changes locally.
 
 5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
 
+    ```
     $ flake8 python_wpapi tests
     $ python setup.py test or py.test
     $ tox
+    ```
 
    To get flake8 and tox, just pip install them into your virtualenv.
 
 6. Commit your changes and push your branch to GitHub::
 
+    ```
     $ git add .
     $ git commit -m "Your detailed description of your changes."
     $ git push origin name-of-your-bugfix-or-feature
+    ```
 
 7. Submit a pull request through the GitHub website.
 
-Pull Request Guidelines
------------------------
+### Pull Request Guidelines
 
 Before you submit a pull request, check that it meets these guidelines:
 
@@ -105,10 +103,10 @@ Before you submit a pull request, check that it meets these guidelines:
    https://travis-ci.org/Lobosque/python_wpapi/pull_requests
    and make sure that the tests pass for all supported Python versions.
 
-Tips
-----
-
-To run a subset of tests::
+## Tips
 
+To run a subset of tests:
 
+    ```
     $ python -m unittest tests.test_python_wpapi
+    ```
diff --git a/HISTORY.md b/HISTORY.md
@@ -0,0 +1,14 @@
+# History
+
+## 0.2.1 (2016-11-16)
+
+* Converted rst to markdown.
+
+## 0.2.0 (2016-11-16)
+
+* Added test suite.
+* Fixed bugs with api exception raising.
+
+## 0.1.0 (2016-11-16)
+
+* First release on PyPI.
diff --git a/HISTORY.rst b/HISTORY.rst
diff --git a/README.md b/README.md
@@ -0,0 +1,25 @@
+# Python Wordpress API
+
+[![Pypi][pypi-image]][pypi-url]
+[![Pyup][pyup-image]][pyup-url]
+
+
+Simple wrapper around the Wordpress REST API
+
+
+* Free software: MIT licensea
+
+## Features
+
+* Will soon work on some documentation
+
+## Tests
+
+```
+make test
+```
+
+[pypi-image]: https://img.shields.io/npm/v/co.svg?style=flat-square
+[pypi-url]: https://npmjs.org/package/co
+[pyup-image]: https://img.shields.io/travis/tj/co.svg?style=flat-square
+[pyup-url]: https://travis-ci.org/tj/co
diff --git a/README.rst b/README.rst
diff --git a/python_wpapi/__init__.py b/python_wpapi/__init__.py
@@ -2,4 +2,4 @@
 
 __author__ = """Lucas Lobosque"""
 __email__ = 'lucas.lobosque@contentools.com'
-__version__ = '0.2.0'
+__version__ = '0.2.1'
diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.2.0
+current_version = 0.2.1
 commit = True
 tag = True
 
diff --git a/setup.py b/setup.py
@@ -3,10 +3,10 @@
 
 from setuptools import setup
 
-with open('README.rst') as readme_file:
+with open('README.md') as readme_file:
     readme = readme_file.read()
 
-with open('HISTORY.rst') as history_file:
+with open('HISTORY.md') as history_file:
     history = history_file.read()
 
 requirements = [
@@ -19,7 +19,7 @@
 
 setup(
     name='python_wpapi',
-    version='0.2.0',
+    version='0.2.1',
     description="Simple wrapper around the Wordpress REST API",
     long_description=readme + '\n\n' + history,
     author="Lucas Lobosque",
