FIX: Fix readme
diff --git a/Makefile b/Makefile
index 32505ae..b541dc9 100644
--- a/Makefile
+++ b/Makefile
@@ -60,6 +60,9 @@
--name codespell-$(VERSION).tar.xz.asc \
--file codespell-$(VERSION).tar.xz.asc
+pypi:
+ python setup.py sdist register upload
+
clean:
rm -rf codespell
rm -rf codespell.1
diff --git a/README.md b/README.md
deleted file mode 100644
index ada21c8..0000000
--- a/README.md
+++ /dev/null
@@ -1,90 +0,0 @@
-codespell
-=========
-
-Fix common misspellings in text files. It's designed primarily for checking
-misspelled words in source code, but it can be used with other files as well.
-
-Information
------------
-
-GitHub project: <https://github.com/lucasdemarchi/codespell>
-
-Mailing list: <codespell@googlegroups.com> with web archives/interface at
- <https://groups.google.com/forum/?fromgroups#!forum/codespell>
-
-
-Repository: <https://github.com/lucasdemarchi/codespell>
-
-Releases: <https://github.com/lucasdemarchi/codespell/releases>
-
-Requirements
-------------
-
-Python 3.0 or above.
-
-make and help2man packages needed for "make install".
-
-Usage
------
-
-Check usage with `./codespell.py -h`. There are a few command line options.
-Note that upon installation with "make install" we don't have the "py" suffix.
-We ship a dictionary that is an improved version of the one available at
-<http://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines>
-after applying them in projects like Linux Kernel, EFL, oFono among others.
-You can provide your own version of the directory, but patches for
-new/different entries are very welcome.
-
-Dictionary format
------------------
-
-The format of the dictionary was influenced by the one it originally came from,
-i.e. from Wikipedia. The difference is how multiple options are treated and
-that the last argument is the reason why a certain entry could not be applied
-directly, but instead be manually inspected. E.g:
-
-1. Simple entry: one wrong word / one suggestion
-
- `calulated->calculated`
-
-2. Entry with more than one suggested fix
-
- `fiel->feel, field, file, phial,`
-
- Note the last comma! You need to use it, otherwise the last suggestion
-will be discarded (see below for why). When there are more than one
-suggestion, automatically fix is not possible and the best we can do is
-to give the user the file and line where the error occurred as well as
-the suggestions.
-
-3. Entry with one word, but with automatically fix disabled
-
- `clas->class, disabled because of name clash in c++`
-
- Note that there isn't a comma in the end of the line. The last argument is
-treated as the reason why a suggestion cannot be automatically applied.
-
-License
--------
-
-The Python script `codespell.py` is available with the following terms:
-(*tl;dr*: [GPL v2][])
-
-> Copyright (C) 2010-2011 Lucas De Marchi <lucas.de.marchi@gmail.com>
-
-> Copyright (C) 2011 ProFUSION embedded systems
-
-> This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; version 2 of the License.
-
-> This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-> You should have received a copy of the GNU General Public License
-along with this program; if not, see
-<http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>.
-
-[GPL v2]:http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..46a0335
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,94 @@
+codespell
+=========
+
+Fix common misspellings in text files. It's designed primarily for checking
+misspelled words in source code, but it can be used with other files as well.
+
+Useful links
+------------
+
+* `GitHub project <https://github.com/lucasdemarchi/codespell>`_
+
+* Mailing list: <codespell@googlegroups.com> with web archives/interface
+ `here <https://groups.google.com/forum/?fromgroups#!forum/codespell>`_
+
+* `Repository <https://github.com/lucasdemarchi/codespell>`_
+
+* `Releases <https://github.com/lucasdemarchi/codespell/releases>`_
+
+Requirements
+------------
+
+Python 2.7 or above.
+
+Installation
+------------
+
+You can use ``pip`` to install codespell with e.g.::
+
+ pip install codespell
+
+Usage
+-----
+
+Check usage with ``./codespell.py -h``. There are a few command line options.
+Note that upon installation with "make install" we don't have the "py" suffix.
+We ship a dictionary that is an improved version of the one available at
+<http://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines>
+after applying them in projects like Linux Kernel, EFL, oFono among others.
+You can provide your own version of the directory, but patches for
+new/different entries are very welcome.
+
+Dictionary format
+-----------------
+
+The format of the dictionary was influenced by the one it originally came from,
+i.e. from Wikipedia. The difference is how multiple options are treated and
+that the last argument is the reason why a certain entry could not be applied
+directly, but instead be manually inspected. E.g:
+
+1. Simple entry: one wrong word / one suggestion::
+
+ calulated->calculated
+
+2. Entry with more than one suggested fix::
+
+ fiel->feel, field, file, phial,
+
+ Note the last comma! You need to use it, otherwise the last suggestion
+ will be discarded (see below for why). When there are more than one
+ suggestion, automatically fix is not possible and the best we can do is
+ to give the user the file and line where the error occurred as well as
+ the suggestions.
+
+3. Entry with one word, but with automatically fix disabled::
+
+ clas->class, disabled because of name clash in c++
+
+ Note that there isn't a comma in the end of the line. The last argument is
+ treated as the reason why a suggestion cannot be automatically applied.
+
+License
+-------
+
+The Python script ``codespell.py`` is available with the following terms:
+(*tl;dr*: [GPL v2][])
+
+> Copyright (C) 2010-2011 Lucas De Marchi <lucas.de.marchi@gmail.com>
+
+> Copyright (C) 2011 ProFUSION embedded systems
+
+> This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; version 2 of the License.
+
+> This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+> You should have received a copy of the GNU General Public License
+along with this program; if not, see
+<http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>.
+
+[GPL v2]:http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
diff --git a/codespell_lib/_codespell.py b/codespell_lib/_codespell.py
index b4d5080..71a9101 100755
--- a/codespell_lib/_codespell.py
+++ b/codespell_lib/_codespell.py
@@ -30,7 +30,7 @@
USAGE = """
\t%prog [OPTIONS] [file1 file2 ... fileN]
"""
-VERSION = '1.9'
+VERSION = '1.9.0'
misspellings = {}
exclude_lines = set()
diff --git a/setup.py b/setup.py
index a5515d0..5619389 100755
--- a/setup.py
+++ b/setup.py
@@ -20,7 +20,7 @@
URL = 'https://github.com/lucasdemarchi/codespell/'
LICENSE = 'GPL v2'
DOWNLOAD_URL = 'https://github.com/lucasdemarchi/codespell/'
-with open('README.md', 'r') as f:
+with open('README.rst', 'r') as f:
LONG_DESCRIPTION = f.read()
if __name__ == "__main__":
