aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJan Tuomi <jan.tuomi@eficode.com>2019-07-02 20:59:07 +0300
committerJan Tuomi <jan.tuomi@eficode.com>2019-07-02 20:59:07 +0300
commit4d8cd954747096024eeb4fab78211717e433ac10 (patch)
tree5db8f2dc4c907a8f0e6c8f86fc5b4e039691ae19 /README.md
parent5cc965ed427fc1ae1b53da0ea6cf9af4f4525b87 (diff)
Add readme
Diffstat (limited to 'README.md')
-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