Update README to include links to online docs - also remove numerous special characters, smart quotes, etc. for cleaner cross-platform presentation. See Issue #109

1 files changed, 27 insertions, 14 deletions

diff --git a/README.rst b/README.rst
index 1cfce44..dca0a71 100644
--- a/README.rst
+++ b/README.rst
@@ -1,5 +1,5 @@
-PyParsing – A Python Parsing Module
-===================================
+PyParsing -- A Python Parsing Module
+====================================
 
 |Build Status|
 
@@ -12,13 +12,13 @@ use of regular expressions. The pyparsing module provides a library of
 classes that client code uses to construct the grammar directly in
 Python code.
 
-(Since first writing this description of pyparsing in late 2003, this
+*[Since first writing this description of pyparsing in late 2003, this
 technique for developing parsers has become more widespread, under the
-name Parsing Expression Grammars - PEGs. See more information on PEGs at
-https://en.wikipedia.org/wiki/Parsing_expression_grammar.)
+name Parsing Expression Grammars - PEGs. See more information on PEGs at*
+https://en.wikipedia.org/wiki/Parsing_expression_grammar *.]*
 
-Here is a program to parse “Hello, World!” (or any greeting of the form
-“salutation, addressee!”):
+Here is a program to parse ``"Hello, World!"`` (or any greeting of the form
+``"salutation, addressee!"``):
 
 .. code:: python
 
@@ -32,30 +32,43 @@ The program outputs the following::
     Hello, World! -> ['Hello', ',', 'World', '!']
 
 The Python representation of the grammar is quite readable, owing to the
-self-explanatory class names, and the use of ‘+’, ‘\|’ and ‘^’ operator
+self-explanatory class names, and the use of '+', '|' and '^' operator
 definitions.
 
-The parsed results returned from parseString() can be accessed as a
+The parsed results returned from ``parseString()`` can be accessed as a
 nested list, a dictionary, or an object with named attributes.
 
 The pyparsing module handles some of the problems that are typically
-vexing when writing text parsers: - extra or missing whitespace (the
-above program will also handle “Hello,World!”, “Hello , World !”, etc.)
-- quoted strings - embedded comments
+vexing when writing text parsers:
+
+- extra or missing whitespace (the above program will also handle ``"Hello,World!"``, ``"Hello , World !"``, etc.)
+- quoted strings
+- embedded comments
 
 The examples directory includes a simple SQL parser, simple CORBA IDL
 parser, a config file parser, a chemical formula parser, and a four-
 function algebraic notation parser, among many others.
 
+Documentation
+=============
+
+There are many examples in the online docstrings of the classes
+and methods in pyparsing. You can find them compiled into online docs
+at https://pyparsing-docs.readthedocs.io/en/latest/. Additional
+documentation resources and project info are listed in the online
+GitHub wiki, at https://github.com/pyparsing/pyparsing/wiki. An
+entire directory of examples is at
+https://github.com/pyparsing/pyparsing/tree/master/examples.
+
 License
 =======
 
-    MIT License. See header of pyparsing.py
+MIT License. See header of pyparsing.py
 
 History
 =======
 
-    See CHANGES file.
+See CHANGES file.
 
 .. |Build Status| image:: https://travis-ci.org/pyparsing/pyparsing.svg?branch=master
    :target: https://travis-ci.org/pyparsing/pyparsing