From 476ccc09aea86c87d533839bb4130cb3307be97d Mon Sep 17 00:00:00 2001 From: Rishi Ghan Date: Thu, 2 Sep 2021 00:15:45 -0700 Subject: [PATCH] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20Edits=20to=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 42373c8..a8013d3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # threetwo-import-service -This microservice houses endpoints for the following functions: +This [moleculer-based](https://github.com/moleculerjs/moleculer-web) microservice houses endpoints for the following functions: 1. Local import of a comic library into mongo (currently supports `cbr` and `cbz` files) 2. Metadata extraction from file, `comicinfo.xml` @@ -15,7 +15,7 @@ This microservice houses endpoints for the following functions: 2. You need `mongo` for the data store. on `macOS` you can use [these instructions](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/) to install it 3. Clone this repo 4. Run `npm i` -5. Assuming you installed mongo correctly, run `MONGO_URI=mongodb://localhost:27017/threetwo npm run dev` +5. Assuming you installed mongo correctly, run `MONGO_URI=mongodb://localhost:27017/threetwo npm run dev` to start the service 6. You should see the service spin up and a list of all the endpoints in the terminal 7. The service can be accessed through `http://localhost:3000/api/import/*` ## Docker Instructions