From a9b4f9256af5a3bebb3e86ad3295e703fb2846ba Mon Sep 17 00:00:00 2001 From: Yevheniy Hvozdikov Date: Sun, 22 Nov 2020 19:06:45 +0100 Subject: [PATCH] Update 'README.md' Adding more instructions for running it. --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 25fe31b..f157eff 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # Pokespearean -Pokemon description API as if it was told by Shakespeare \ No newline at end of file +Pokemon description API as if it was written by Shakespeare. + +## How to run it + +The project that needs to be run should be the one named `Pokespearean`. +The project should be run using Visual Studio 2019(VS). +The project has 3 running profiles: +1. IIS Express +2. Pokespearean +3. Docker + +The first 2 profiles will run the project directly(clicking on the green play button in VS), opening a browser window at `http://localhost:5000`. + +In this case you need to add to the path "/pokemon/{pokemon name}" where instead of `{pokemon name}` you need write the name of the pokemon, if the pokemon is found, a json string with `name` and `description` will be shown in the browser. + +In case you want to use the "Docker" profile, make sure you have "Docker Desktop" installed, from the [docker website](https://www.docker.com/products/docker-desktop). \ No newline at end of file