From 1cc2189a0a9320029204057c193b5ab7ac58af30 Mon Sep 17 00:00:00 2001 From: John Bampton Date: Tue, 8 Mar 2022 21:10:37 +1000 Subject: [PATCH] Fix spelling and enhance the README --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a908b4c..b191ed4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # WhereMoney Webservice -## Installation guid +## Installation guide The easiest way to install the webservice is by using Docker. ## Docker installation: @@ -14,7 +14,7 @@ git clone https://github.com/Asrez/WhereMoneyAPI.git cd WhereMoneyAPI ``` -**Open up .env file to set env variables** +**Open up `.env` file to set env variables** ```shell vi ./.env ``` @@ -34,7 +34,7 @@ docker-compose up -d ## Manual installation: > **Make sure you have openjdk >= 11 installed on your machine.** -> **Make sure you have PostgresSql database installed and running on your machine.** +> **Make sure you have PostgreSQL database installed and running on your machine.** > **You are going to need a database and a user with privileges to that database.** @@ -48,12 +48,12 @@ git clone https://github.com/Asrez/WhereMoneyAPI.git cd WhereMoneyAPI ``` -**Open up application.yml stored in ./src/main/resources/ file to set variables** +**Open up application.yml stored in `./src/main/resources/` file to set variables** ```shell vi ./src/main/resources/application.yml ``` -**Simply run the jar file with --spring.config.location specified** +**Simply run the jar file with `--spring.config.location` specified** ```shell java -jar jars/where-money-api.jar --spring.config.location=./src/main/resources/application.yml ```