Merge pull request #21 from Eppo-exp/malo/add-read-me

Add ReadMe to this repo

README.md

@@ -0,0 +1,12 @@
+### Eppo Metrics Sync
+
+This Python package allows to post a directory of yaml files to Eppo's API. Documentation is available in Eppo's [documentation page](https://docs.geteppo.com/data-management/certified-metrics/).
+
+#### Deploying the package
+
+Note: this section is intended for Eppo package maintainers.
+- Bump version in ```setup.py```
+- Install required tools:```python3 -m pip install --upgrade setuptools wheel twine``` 
+- Generate distribution packages:```python3 setup.py sdist bdist_wheel```
+- Use Twine to upload the package:```python3 -m twine upload dist/*```
+You'll be prompted for your PyPI username and password as well as the API key that is available in 1Password.

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='eppo_metrics_sync',
-    version='0.0.7',
+    version='0.0.8',
     packages=find_packages(),
     install_requires=[
         'PyYAML', 'jsonschema', 'requests'