From 04dc9ae612c7a2305bcf24d2ca14bac415090d44 Mon Sep 17 00:00:00 2001 From: 4rkal <4rkal@proton.me> Date: Thu, 12 Sep 2024 21:45:22 +0300 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index eee65c5..b84a503 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ # shortr A blazingly fast url shortener, written in go + +## Instaallation +The first step is cloning this repo: + +```shell +git clone https://github.com/4rkal/shortr && cd shortr +``` +Now you can run the application via docker. + +### Using docker +Assuming that you have docker compose installed simply run + +``` +docker compose up +``` + +Now the application should be available by vissiting `localhost:8080` +