Update readme and setup file

karlicoss · karlicoss · commit 702faa6c05ff · 2019-09-18T21:56:07.000+01:00
diff --git a/README.rst b/README.rst
@@ -1,13 +1,10 @@
 ===========================================================
-  orgparse - Python module for reading Emacs org-mode file
+  orgparse - Python module for reading Emacs org-mode files
 ===========================================================
 
 
-Links:
-
-* `Documentation (at Read the Docs) <https://orgparse.readthedocs.org>`_
+* `Documentation (Read the Docs) <https://orgparse.readthedocs.org>`_
 * `Repository (at GitHub) <https://github.com/karlicoss/orgparse>`_
-* `Issue tracker (at GitHub) <https://github.com/karlicoss/orgparse/issues>`_
 * `PyPI <https://pypi.python.org/pypi/orgparse>`_
 * `Travis CI <https://travis-ci.org/karlicoss/orgparse>`_  |build-status|
 
@@ -18,16 +15,17 @@ Links:
 Install
 -------
 
-You can install `orgparse` from PyPI_::
-
   pip install orgparse
 
 
 Usage
 -----
 
-Loading org object
-^^^^^^^^^^^^^^^^^^
+There are pretty extensive doctests if you're interested in some specific method. Otherwise here are some example snippets:
+
+
+Load org node
+^^^^^^^^^^^^^
 ::
 
     from orgparse import load, loads
@@ -70,8 +68,8 @@ Traverse org tree
 * Heading 1
 
 
-Accessing to node attributes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Accessing node attributes
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 >>> root = loads('''
 ... * DONE Heading          :TAG:
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -15,14 +15,17 @@
 source_suffix = '.rst'
 master_doc = 'index'
 
+# TODO not sure I'm doing that right..
+import orgparse
+
 # General information about the project.
 project = u'orgparse'
 copyright = u'2012, Takafumi Arakaki'
 
 # The short X.Y version.
-version = '0.0.1'
+version = orgparse.__version__
 # The full version, including alpha/beta/rc tags.
-release = '0.0.1.dev3'
+release = orgparse.__version__
 
 exclude_patterns = []
 
diff --git a/orgparse/__init__.py b/orgparse/__init__.py
@@ -5,15 +5,12 @@
 # ]]]
 """
 ===========================================================
-  orgparse - Python module for reading Emacs org-mode file
+  orgparse - Python module for reading Emacs org-mode files
 ===========================================================
 
 
-Links:
-
-* `Documentation (at Read the Docs) <https://orgparse.readthedocs.org>`_
+* `Documentation (Read the Docs) <https://orgparse.readthedocs.org>`_
 * `Repository (at GitHub) <https://github.com/karlicoss/orgparse>`_
-* `Issue tracker (at GitHub) <https://github.com/karlicoss/orgparse/issues>`_
 * `PyPI <https://pypi.python.org/pypi/orgparse>`_
 * `Travis CI <https://travis-ci.org/karlicoss/orgparse>`_  |build-status|
 
@@ -24,16 +21,17 @@
 Install
 -------
 
-You can install `orgparse` from PyPI_::
-
   pip install orgparse
 
 
 Usage
 -----
 
-Loading org object
-^^^^^^^^^^^^^^^^^^
+There are pretty extensive doctests if you're interested in some specific method. Otherwise here are some example snippets:
+
+
+Load org node
+^^^^^^^^^^^^^
 ::
 
     from orgparse import load, loads
@@ -76,8 +74,8 @@
 * Heading 1
 
 
-Accessing to node attributes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Accessing node attributes
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 >>> root = loads('''
 ... * DONE Heading          :TAG:
@@ -118,7 +116,7 @@
 from .node import parse_lines
 from .utils.py3compat import basestring
 
-__version__ = '0.1.1'
+__version__ = '0.1.2dev0'
 __author__ = 'Takafumi Arakaki'
 __license__ = 'BSD License'
 __all__ = ["load", "loads", "loadi"]
diff --git a/setup.py b/setup.py
@@ -15,13 +15,19 @@
     package_data={
         'orgparse.tests.data': ['*.org'],
     },
+
     author=orgparse.__author__,
     author_email='aka.tkf@gmail.com',
-    url='https://github.com/tkf/orgparse',
+    maintainer='Dima Gerasimov (@karlicoss)',
+    maintainer_email='karlicoss@gmail.com',
+
+    url='https://github.com/karlicoss/orgparse',
     license=orgparse.__license__,
+
     description='orgparse - Emacs org-mode parser in Python',
     long_description=orgparse.__doc__,
-    keywords='org-mode, Emacs, parser',
+
+    keywords='org org-mode emacs',
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'License :: OSI Approved :: BSD License',
