diff --git a/README.md b/README.md index 1fbe727..fca78df 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,37 @@ # The Codex Mythica -The Codex Mythica is a database of all of the cards released for the Mythic Wars card game. Browse through all of the cards in the game, or search to find the card(s) you're looking for. +The Codex Mythica is a database of all of the cards released for the Mythic Wars card game. You can find it at https://codex.mythicwarsgame.com/. -You can find it at https://codex.mythicwarsgame.com/. +## Installing + ++ Requires: [git](https://git-scm.com/), [Node](https://nodejs.org/), [Express](https://expressjs.com/), and (optionally) a static web server (we recommend [nginx](https://nginx.org/)). + ++ Clone from the git repo: + +```shell +git clone https://git.itsericwoodward.com/eric/codex-mythica.git mwg-codex +``` + ++ Go into the directory for the site: + +```shell +cd mwg-codex +``` + ++ Install the required NPM libraries: + +```shell +npm install +``` + ++ Launch the production binary file: + +```shell +./bin/www-prod +``` + ++ Share and enjoy! -The code is on GitHub at https://github.com/ItsEricWoodward/codex-mythica. ## License diff --git a/package.json b/package.json index d5ceb1f..63a7f25 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@mysticbits/codex-mythica", - "version": "0.3.1", + "version": "0.4.0", "private": true, "scripts": { "start": "nodejs ./bin/www" @@ -18,5 +18,8 @@ "name": "Eric Woodward", "email": "eric@itsericwoodward.com", "url": "https://itsericwoodward.com/" + }, + "devDependencies": { + "ejs-lint": "^0.3.0" } }