aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..163e7da
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# Convert 5eTools JSON output to DnDAppFile XML
+
+## Installation
+
+Install Node.js. Run:
+
+ $ npm install
+
+## Usage
+
+ $ node index.js input.json | tee output.xml
+
+You can also install the software globally to use it from anywhere.
+
+ $ npm i -g .
+ $ 5eTools-to-DnDAppFile input.json