Merge pull request #91 from qwell/patch-1

Update README.rst. Consistency, spelling, minor cleanup.

README.rst

@@ -1,11 +1,11 @@
 Courts-DB
 =========
 
-Courts-DB is an open source repository to organize a db of all courts current and historical.
-It was built for use in Courtlistener.com.
+Courts-DB is an open source repository to organize a database of all courts current and historical.
+It was built for use in CourtListener.com.
 
-Its main goal is to interface with CL to identify historical and current courts
-by string.  It incldues mechanisms to filter results based on dates and/or whether it is a bankruptcy court.
+Its main goal is to interface with CourtListener to identify historical and current courts
+by string.  It includes mechanisms to filter results based on dates and/or whether it is a bankruptcy court.
 
 Further development is intended and all contributors, corrections and additions are welcome.
 
@@ -14,12 +14,12 @@ Background
 
 Free Law Project built this database using the metadata (case names, dates etc.)
 of over 16 millions data points.  This data represents hundreds of hours of
-research and testing.  We believe to be the most extensive open dataset of its kind.
+research and testing.  We believe this to be the most extensive open dataset of its kind.
 
 Quickstart
 ===========
 
-You can feed in a courtlistener Court_ID or string to find a court.
+You can feed in a CourtListener Court Identifier or string to find a court.
 
 ::
 
@@ -70,8 +70,9 @@ You can feed in a courtlistener Court_ID or string to find a court.
 
 Filtering on less unique strings is built in.
 
-Feed a date string or bankruptcy flag to filter on those parameters
-For example District of Massachusetts is non unique and returns both the Federal District Court of Massachusetts and its Bankruptcy Court
+Feed a date string or bankruptcy flag to filter on those parameters.
+For example District of Massachusetts is non unique and returns both the Federal District Court of Massachusetts and its Bankruptcy Court.
+
 ::
 
         from datetime import datetime as dt
@@ -99,40 +100,40 @@ For example District of Massachusetts is non unique and returns both the Federal
 
 Some Notes on the Data
 ======================
-Somethings to keep in mind as you are reviewing the data.
+Some things to keep in mind as you are reviewing the data:
 
-1. The data is devided into two files courts.json and variables.json
-2. Courts.json holds the bulk of the information
-3. Variables.json holds templates for large numbers of regexes.
+1. The data is divided into two files ``courts.json`` and ``variables.json``.
+2. ``courts.json`` holds the bulk of the information.
+3. ``variables.json`` holds templates for large numbers of regexes.
 
 Fields
 ======
 
-1. :code:`id` — string; Courtlistener Court Identifier
-2. :code:`court_url` — string; url for court website
-3. :code:`regex` —  array; regexes patterns to find courts
-4. :code:`examples` —  array; regexes patterns to find courts
-5. :code:`name` — string; full name of the court
-6. :code:`name_abbreviation` — string; court name abbreviations
-7. :code:`dates` — Array; Contains start date, end date and notes on date range
-8. :code:`system` — string; Defines main jurisdiction, ex. State, Federal, Tribal
-9. :code:`level` — string; code defining where court is in system structure, ex. COLR (Court of Last Resort), IAC (Intermediate Appellate Court), GJC (General Jurisdiction Court), LJC (Limited Jurisdiction Court)
-10. :code:`location` — string; refers to the physical location of the main court
-11. :code:`type` — string; Identifies kind of cases handled (Trial, Appellate, Bankruptcy, AG)
-12. :code:`citation_string` — string; Identifies the string used in a citation to refer to the court
-13. :code:`notes` — string; A place to put notes about a court
+1. ``id`` — string; CourtListener Court Identifier
+2. ``court_url`` — string; url for court website
+3. ``regex`` —  array; regexes patterns to find courts
+4. ``examples`` —  array; regexes patterns to find courts
+5. ``name`` — string; full name of the court
+6. ``name_abbreviation`` — string; court name abbreviations
+7. ``dates`` — Array; contains start date, end date and notes on date range
+8. ``system`` — string; defines main jurisdiction, ex. State, Federal, Tribal
+9. ``level`` — string; code defining where court is in system structure, ex. COLR (Court of Last Resort), IAC (Intermediate Appellate Court), GJC (General Jurisdiction Court), LJC (Limited Jurisdiction Court)
+10. ``location`` — string; refers to the physical location of the main court
+11. ``type`` — string; identifies kind of cases handled (Trial, Appellate, Bankruptcy, AG)
+12. ``citation_string`` — string; identifies the string used in a citation to refer to the court
+13. ``notes`` — string; a place to put notes about a court
 
 Installation
 ============
 
-Installing courts-db is easy.
+Installing Courts-DB is easy.
 
     ::
 
         pip install courts_db
 
 
-Or install the latest dev version from github
+Or install the latest development version from GitHub.
 
     ::
 
@@ -143,8 +144,8 @@ Or install the latest dev version from github
 Future
 =======
 
-1) Continue to improve and expand the dataset.
-2) Add filtering mechanisms by state, reporters, citation(s), judges, counties and cities.
+1. Continue to improve and expand the dataset.
+2. Add filtering mechanisms by state, reporters, citation(s), judges, counties and cities.
 
 
 Deployment
@@ -154,38 +155,37 @@ If you wish to create a new version, the process is:
 
 1. Update version info in ``setup.py`` and commit it.
 
-1. Tag the commit with the version number.
+2. Tag the commit with the version number.
 
 To proceed manually
 -------------------
 
-1. Push your commit. CI should take care of the rest.
+1. Push your commit. CI (Continuous Integration) should take care of the rest.
 
 
 To proceed manually
 -------------------
 
-1. Install the requirements in requirements_dev.txt
+1. Install the requirements in ``requirements_dev.txt``.
 
-1. Set up a config file at ~/.pypirc
+2. Set up a config file at ``~/.pypirc``.
 
-1. Generate a universal distribution that worksin py2 and py3 (see setup.cfg)
+3. Generate a universal distribution that works in Python 2 and Python 3 (see ``setup.cfg``).
 
     ::
 
         python setup.py sdist bdist_wheel
 
-1. Upload the distributions
+4. Upload the distributions.
 
     ::
 
-        twine upload dist/* -r pypi (or pypitest)
-
+        twine upload dist/* -r pypi # (or pypitest)
 
 
 License
 =======
 
 This repository is available under the permissive BSD license, making it easy and safe to incorporate in your own libraries.
 
-Pull and feature requests welcome. Online editing in Github is possible (and easy!)
+Pull and feature requests welcome. Online editing in GitHub is possible (and easy!)