From ad3b7b324c38941e63c17299d3c6545a657a392a Mon Sep 17 00:00:00 2001
From: Alex Mykyta <amykyta3@users.noreply.github.com>
Date: Tue, 6 Nov 2018 22:41:58 -0800
Subject: [PATCH] Prep for release

---
 README.md                  | 51 ++++++++++++++++++++++++++++++++++++++
 ralbot/ipxact/__about__.py |  2 +-
 setup.py                   |  4 +--
 3 files changed, 54 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index fdcfa2a..2aa830c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,53 @@
 # RALBot-ipxact
 Convert compiled SystemRDL input into IP-XACT XML
+
+## Installing
+Install from [PyPi](https://pypi.org/project/ralbot-ipxact) using pip:
+
+    python3 -m pip install ralbot-ipxact
+
+
+## Usage
+Pass the elaborated output of the [SystemRDL Compiler](http://systemrdl-compiler.readthedocs.io)
+into the exporter.
+
+Assuming `root` is the elaborated top-level node, or an internal `AddrmapNode`:
+
+```python
+from ralbot.ipxact import IPXACTExporter
+
+exporter = IPXACTExporter()
+
+exporter.export(root, "path/to/output.xml")
+```
+
+
+## Reference
+
+### `IPXACTExporter(**kwargs)`
+Constructor for the HTML exporter class
+
+**Optional Parameters**
+
+* `vendor`
+    * Vendor url string. Defaults to "example.org"
+* `library`
+    * library name string. Defaults to "mylibrary"
+* `version`
+    * Version string. Defaults to "1.0"
+* `standard`
+    * IP-XACT Standard to use. Currently only supports `ralbot.ipxact.Standard.IEEE_1685_2014`
+* `xml_indent`
+    * String to use for each indent level. Defaults to 2 spaces.
+* `xml_newline`
+    * String to use for line breaks. Defaults to newline.
+
+### `IPXACTExporter.export(node, path)`
+Perform the export!
+
+**Parameters**
+
+* `node`
+    * Top-level node to export. Can be the top-level `RootNode` or any internal `AddrmapNode`.
+* `path`
+    * Output file.
diff --git a/ralbot/ipxact/__about__.py b/ralbot/ipxact/__about__.py
index 3dc1f76..5becc17 100644
--- a/ralbot/ipxact/__about__.py
+++ b/ralbot/ipxact/__about__.py
@@ -1 +1 @@
-__version__ = "0.1.0"
+__version__ = "1.0.0"
diff --git a/setup.py b/setup.py
index b308bea..82594f1 100644
--- a/setup.py
+++ b/setup.py
@@ -22,7 +22,7 @@
     packages=['ralbot.ipxact'],
     include_package_data=True,
     install_requires=[
-        "systemrdl-compiler",
+        "systemrdl-compiler>=1.2.0",
     ],
     classifiers=(
         "Development Status :: 5 - Production/Stable",
@@ -32,7 +32,7 @@
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3 :: Only",
         "Intended Audience :: Developers",
-        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)  e",
+        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
         "Operating System :: OS Independent",
         "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
     ),