From 870b80998eccbf551bc55908d2740d905fcff0dd Mon Sep 17 00:00:00 2001 From: Joe-Dowd Date: Sat, 4 Apr 2020 00:19:28 +0100 Subject: [PATCH] updated the readme --- README.MD | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.MD b/README.MD index d56f940..0a19f3a 100644 --- a/README.MD +++ b/README.MD @@ -20,12 +20,17 @@ The client web browser extension is available here: https://github.com/ajayyy/Sp This is a node.js server, so clone this repo and run `npm install` to install all dependencies. -Make sure to create the databases in the `databases` folder out of the database schemas. +If you don't want to use a fresh database, make sure to put the database files in the `./databases` folder if you want to use an pre-existing database. Rename `config.json.example` to `config.json` and fill the parameters inside. Make sure to remove the comments as comments are not supported in JSON. +Ensure all the tests pass with `npm test` + Run the server with `npm start`. +# Developing +If you want to make changes, run `npm run dev` to automatically reload the server and run tests whenever a file is saved. + # API Docs Available [here](https://github.com/ajayyy/SponsorBlock/wiki/API-Docs)