Move the README file to RST for PyPi

2 files changed, 33 insertions, 29 deletions

diff --git a/README.md b/README.md
deleted file mode 100644
index 4faeacd..0000000
--- a/README.md
+++ /dev/null
@@ -1,29 +0,0 @@
-# PluginBase
-
-PluginBase is a module for Python that enables the
-development of flexible plugin systems in Python.
-
-Step 1:
-```python
-from pluginbase import PluginBase
-plugin_base = PluginBase(package='yourapplication.plugins')
-```
-
-Step 2:
-```python
-plugin_source = plugin_base.make_plugin_source(
-    searchpath=['./path/to/plugins', './path/to/more/plugins'])
-```
-
-Step 3:
-```python
-with plugin_source:
-    from yourapplication.plugins import my_plugin
-my_plugin.do_something_cool()
-```
-
-Or alternatively:
-```python
-my_plugin = plugin_source.load_plugin('my_plugin')
-my_plugin.do_something_cool()
-```
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..49a15c3
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,33 @@
+PluginBase
+==========
+
+PluginBase is a module for Python that enables the development of flexible plugin systems in Python.
+
+Step 1:
+
+.. code-block:: python
+
+   from pluginbase import PluginBase
+   plugin_base = PluginBase(package='yourapplication.plugins')
+
+Step 2:
+
+.. code-block:: python
+
+   plugin_source = plugin_base.make_plugin_source(
+       searchpath=['./path/to/plugins', './path/to/more/plugins'])
+
+Step 3:
+
+.. code-block:: python
+
+   with plugin_source:
+       from yourapplication.plugins import my_plugin
+   my_plugin.do_something_cool()
+
+Or alternatively:
+
+.. code-block:: python
+
+   my_plugin = plugin_source.load_plugin('my_plugin')
+   my_plugin.do_something_cool()