diff --git a/README.md b/README.md index 5d95e06..dbc9d6e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ -# LNReader Extensions -[WIP] +# LNReader Sources + +This repository contains a REST API for [LNReader](https://github.com/rajarsheechatterjee/lnreader) + +## Setup locally + +#### Clone this repository +``` +git clone https://github.com/LNReader/lnreader-extensions.git +``` + +#### Install dependencies +``` +npm install +``` + +#### Start the server +``` +npm start +``` + +### Currently supported sources +- BoxNovel +- ReadLightNovel