Add README.md and long description

Signed-off-by: Stephen Gallagher <sgallagh@redhat.com>

Author: sgallagher

README.md

@@ -0,0 +1,66 @@
+# mmdzanata
+## Prerequisites
+* [libmodulemd](https://github.com/fedora-modularity/libmodulemd)
+* [koji](https://pagure.io/koji)
+* [zanata-client](https://github.com/zanata/zanata-client)
+
+To install on Fedora 28+, run:
+```
+dnf install libmodulemd koji zanata-client
+```
+
+## Installation
+With the prerequisites installed, the latest version can be installed with
+`pip install mmdzanata` or on Fedora 28+ with `dnf install mmdzanata`
+(recommended).
+
+## CLI Usage
+### Zanata Client Setup
+Use of the upload feature for string extraction requires setting up the
+Zanata client appropriately. Follow the
+[instructions](http://docs.zanata.org/en/release/client/configuration/) from
+Zanata to set up your `~/.config/zanata.ini` file appropriately. Note that
+you will want to do this against
+https://fedora.zanata.org
+and not
+https://translate.zanata.org
+
+### Extract Translatable Strings
+To extract translatable strings from modules for a particular Fedora
+release (e.g. f29):
+```
+mmdzanata --branch f29 extract [--upload]
+```
+This will read all of the module metadata from the Koji build-system and
+convert the translatable strings to a Zanata-compatible gettext document. If
+ `--upload` is passed, it will also attempt to use the `zanata-cli` tool to
+ upload the strings to the Zanata server. See the "Zanata Client Setup"
+ section above for information on how to configure this.
+
+ ### Produce modulemd-translations YAML
+ To read the translated strings from Zanata and convert them into
+ modulemd-translations YAML documents that can be included in repodata:
+ ```
+ mmdzanata --branch f29 generate_modulemd
+ ```
+
+ This will produce a YAML file in the current directory with all known
+ translated strings.
+
+## API
+### mmdzanata
+The mmdzanata class has two primary methods:
+* get_module_catalog_from_tags()
+* generate_metadata()
+
+#### mmdzanata.get_module_catalog_from_tags()
+This returns a babel.message.Catalog object containing all of the
+translatable strings from any module tagged with one of the passed tags.
+
+#### mmmdzanata.generate_metadata()
+This returns an iterable of modulemd-translation objects from the supplied
+Zanata project and branch.
+
+### mmdzanata.fedora
+This class provides helper routines for dealing with translations in Fedora
+Modules.

setup.py

@@ -14,15 +14,19 @@
 
 from setuptools import setup
 
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
 setup(
     name='mmdzanata',
-    version='0.1',
+    version='0.2',
     packages=['mmdzanata', 'mmdzanata.fedora'],
-    url='',
+    url='https://github.com/sgallagher/modulemd-zanata',
     license='MIT',
     author='Stephen Gallagher',
     author_email='sgallagh@redhat.com',
     description='Tools for working with translations of modulemd',
+    long_description=long_description,
     # mmdzanata also requires koji, libmodulemd and zanata-client which are not
     # available on PyPI and must be installed separately. On Fedora, this is
     # done with `dnf install koji libmodulemd zanata-client`
@@ -34,4 +38,9 @@
     entry_points={
         'console_scripts': ['mmdzanata=mmdzanata.cli:cli'],
     },
+    classifiers=(
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: POSIX :: Linux",
+    ),
 )