+ Added README

README.md

@@ -1,5 +1,61 @@
-## Tests
+# Gura parser
+
+This repository contains the implementation of a [Gura][gura] format parser in Python.
+
+
+## Installation
+
+`pip install gura-parser`
+
+
+## Usage
+
+```python
+from gura_parser import GuraParser
+
+gura_string = """
+# This is a Gura document.
+title: "Gura Example"
+
+an_object:
+    username: "Stephen"
+    pass: "Hawking"
+
+# Line breaks are OK when inside arrays
+hosts: [
+  "alpha",
+  "omega"
+]
+"""
+
+parser = GuraParser()
+parsed_Gura = parser.loads(gura_string)
+
+# Loads: transforms a Gura string into a dictionary
+print(parsed_Gura)  # {'title': 'Gura Example', 'an_object': {'username': 'Stephen', 'pass': 'Hawking'}, 'hosts': ['alpha', 'omega']}
+
+# Dumps: transforms a dictionary into a Gura string
+print(parser.dumps(parsed_Gura))
+```
+
+
+## Contributing
+
+All kind of contribution is welcome! There are some TODOs to complete:
+
+- [] Add line and position in semantics errors (like InvalidIndentationError) messages.
+- [] Replace `getattr` in `match()` method for a tuple of Callable objects to make the code more typed.
+- [] Add some more tests.
+
+
+### Tests
 
 To run all the tests: `python -m unittest`. More info in [official Unittest docs][unittest-docs]
 
-[unittest-docs]: https://docs.python.org/3/library/unittest.html#module-unittest
+[unittest-docs]: https://docs.python.org/3/library/unittest.html#module-unittest
+[gura]: https://github.com/jware-solutions/gura
+
+
+## Licence
+
+This repository is distributed under the terms of the MIT license.