add description for pypi

Author: tardyp

Diff for: README.md

@@ -14,3 +14,35 @@ that you can put anywhere in your path.
 * [repo Manifest Format](./docs/manifest-format.md)
 * [repo Hooks](./docs/repo-hooks.md)
 * [Submitting patches](./SUBMITTING_PATCHES.md)
+
+
+# About pypi version
+
+Version in pypi is not the official version from google, but a friendly fork, with support for normal setup.py style installation
+
+- local imports replaced by module imports, "repo" being the name of the python module
+- subcommand discovery uses the python entrypoint system
+- support for custom repo subcommand in an separate python package
+
+## Installation
+
+```
+pip3 install --user gitrepo
+```
+
+## Custom commands
+
+- create a python module starting from any example in the repo/subcmds directory
+
+- add an entrypoint to your setup.py module:
+
+```python
+  setup(...,
+    install_requires=["gitrepo"],
+    entry_points={
+      'repo.subcmds': [
+        'my_custom_cmd = mycustomrepo.my_custom_cmd:CustomCmd',
+    }
+  )
+```
+Then you can ask your developers to install your own `mycustomrepo` package instead of the `gitrepo` package.

Diff for: setup.py

@@ -1,7 +1,10 @@
 from setuptools import setup, find_packages
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
 setup(
   name="gitrepo",
-  version="1.13.2",
+  version="1.13.2-1",
   packages=find_packages(),
 
   package_data={
@@ -14,6 +17,8 @@
   author="git-repo contributors",
   author_email="[email protected]",
   description="Repo helps manage many Git repositories, does the uploads to revision control systems, and automates parts of the development workflow.",
+  long_description=long_description,
+  long_description_content_type="text/markdown",
   license="Apache",
   keywords="git repo android workflow",
   url="https://gerrit.googlesource.com/git-repo/",