initial commit

README.txt

@@ -0,0 +1,36 @@
+# 5e Artisanal Database Download
+
+This zip file contains a full copy of the 5e Artisanal Database.
+
+Please note, the 5eADB is a reward for patrons of Sly Flourish. If you are not a patron, please join up here:
+
+<https://www.patreon.com/c/slyflourish>
+
+By joining the patreon, you'll support future updates of the 5eADB, support the rest of the work I do, and get access to a whole pile of other rewards!
+
+## Using the 5eADB
+
+The 5eADB can be used in four ways:
+
+### Use the Copy Hosted at Sly Flourish
+
+You can find the link to the current version of the 5e Artisanal Database on the Sly Flourish Patreon rewards page located at:
+
+<https://www.patreon.com/posts/sly-flourish-34953933>
+
+### Run it locally in your own web browser
+
+Click on "index.html" in the top level directory of the 5eADB. It should launch in your default web browser and you can access all features there just like you were navigating it on the web.
+
+### Copy "md" directories to your Obsidian Vault
+
+Navigate down the folders under the root directory to find "md" directories for any given ruleset or dataset. Copy those md directories to your Obsidian vault directory to copy over all the markdown files for those sources. Rename them so you can see what they are in your vault.
+
+### Host it on your own private web server
+
+Copy the whole directory and all subdirectories to the directory you use to host HTML files. There is no server-side code for the 5eADB – it's all HTML with some javascript and markdown files.
+
+### Licensing
+
+See the "licensing.html" file in the root directory for licensing information.
+