Add boilerplate information to README (#20)

Author: juliusgeo

README.rst

@@ -1,11 +1,71 @@
-This package provides an ``ExplainCollection`` class
-that allows that allows PyMongo's Collection methods to be explained_
+==============
+PyMongoExplain
+==============
+
+:Info: Explain collections in PyMongo. See
+       `GitHub <https://github.com/mongodb-labs/pymongoexplain>`_
+       for the latest source.
+:Author: Julius Park
+
+About
+=====
+This package provides an ``ExplainCollection`` class that allows PyMongo's Collection methods to be explained_
 
 .. _explained: https://docs.mongodb.com/master/reference/command/explain/#dbcmd.explain.
 
+Installation
+============
+
+To install this package simply use pip: ::
+
+    pip install pymongoexplain
+
+Support / Feedback
+==================
+
+For questions, discussions, or general technical support, visit the MongoDB Community Forums.
+The MongoDB Community Forums are a centralized place to connect with other MongoDB users, ask questions, and get answers.
+
+Bugs / Feature Requests
+=======================
+
+Think you’ve found a bug? Want to see a new feature in PyMongoExplain?
+Please open an issue on this GitHub repository.
+
+How To Ask For Help
+-------------------
+
+Please include all of the following information when opening an issue:
+
+- Detailed steps to reproduce the problem, including full traceback, if possible.
+- The exact python version used, with patch level::
+
+  $ python -c "import sys; print(sys.version)"
+
+- The exact version of PyMongo used (if applicable), with patch level::
+
+  $ python -c "import pymongo; print(pymongo.version); print(pymongo.has_c())"
+
+- The exact version of PyMongoExplain used::
+
+  $ python -c "import pymongoexplain; print(pymongoexplain.version)"
+
+
+Dependencies
+============
+
+PyMongoExplain requires CPython 3.5+, and PyPy3.5+.
+
+PyMongoExplain requires `PyMongo>=3.10,<4 <https://github.com/mongodb/mongo-python-driver/>`_
+
+Testing
+=======
+
+The easiest way to run the tests is to run **python setup.py test** in
+the root of the distribution.
 
 Tutorial
-########
+========
 
 PyMongo operations in existing application code can be explained by swapping ``Collection`` objects with ``ExplainCollection``
 objects. The ``ExplainCollection`` class provides all CRUD API methods provided by PyMongo's ``Collection``,
@@ -22,37 +82,32 @@ Now you are ready to explain some commands. Remember that explaining a command d
 
 Now ``result`` will contain the output of running explain on the given ``update_one`` command::
 
-    {'$clusterTime':
-        {'signature': {
-            'keyId': 0, 'hash': b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'},
-            'clusterTime': Timestamp(1595603051, 3)},
-            'serverInfo': {'host': 'Juliuss-MBP.verizon.net', 'version': '4.4.0-rc13', 'port': 27017, 'gitVersion': '27f5c1ee9f513f29fe30b8ebefed99581428c6e1'},
-            'queryPlanner':
-                {'plannerVersion': 1,
-                'queryHash': 'CD8F6D8F',
-                'parsedQuery':
-                    {'$and': [
-                    {'category': {'$eq': 'apparel'}},
-                    {'quantity': {'$eq': 1057}}]},
-                    'namespace': 'db.products',
-                    'indexFilterSet': False,
-                    'winningPlan':
-                    {'inputStage':
-                        {'filter':
-                            {'$and': [
-                                {'category': {'$eq': 'apparel'}},
-                      {'quantity': {'$eq': 1057}}]},
-                       'stage': 'COLLSCAN', 'direction': 'forward'},
-                       'stage': 'UPDATE'}, 'planCacheKey': 'CD8F6D8F',
-                      'rejectedPlans': []}, 'ok': 1.0,
-                      'operationTime': Timestamp(1595603051, 3)}
+    {'ok': 1.0,
+     'operationTime': Timestamp(1595603051, 3),
+     'queryPlanner': {'indexFilterSet': False,
+                      'namespace': 'db.products',
+                      'parsedQuery': {'$and': [{'category': {'$eq': 'apparel'}},
+                                               {'quantity': {'$eq': 1057}}]},
+                      'planCacheKey': 'CD8F6D8F',
+                      'plannerVersion': 1,
+                      'queryHash': 'CD8F6D8F',
+                      'rejectedPlans': [],
+                      'winningPlan': {'inputStage': {'direction': 'forward',
+                                                     'filter': {'$and': [{'category': {'$eq': 'apparel'}},
+                                                                         {'quantity': {'$eq': 1057}}]},
+                                                     'stage': 'COLLSCAN'},
+                                      'stage': 'UPDATE'}},
+     'serverInfo': {'gitVersion': '27f5c1ee9f513f29fe30b8ebefed99581428c6e1',
+                    'host': 'Juliuss-MBP.verizon.net',
+                    'port': 27017,
+                    'version': '4.4.0-rc13'}}
 
 
 Since ``ExplainCollection`` instances provide all the same methods provided by ``Collection`` instances, explaining operations in your application code is a simple matter of replacing ``Collection`` instances in your application code with ``ExplainCollection`` instances.
 
 
 Explaining commands in a script
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------------------
 
 You can also run explain on all commands within a Python script using our CLI tool.
 Given a script that contains ``pymongo`` commands within it, you can simply run: ::
@@ -65,4 +120,6 @@ within that script, in addition to running the script itself.
 Any positional parameters or arguments required by your script can be
 simply be appended to the invocation as follows::
 
-    python3 -m pymongoexplain <path/to/your/script.py> [PARAMS] [--optname OPTS]
+    python3 -m pymongoexplain <path/to/your/script.py> [PARAMS] [--optname OPTS]
+
+