docs: updating readme

Author: lotyp

Makefile

@@ -1,6 +1,4 @@
--include .env
-
-CURRENT_DIR ?= $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
+export DOCKER_BUILDKIT ?= 1
 DOCKER_COMPOSE ?= docker-compose
 BUILDER_IMAGE ?= wayofdev/build-deps:alpine-latest
 
@@ -57,7 +55,7 @@ env: ## Generate .env file from example
 	cp -f .env.example .env
 .PHONY: env
 
-cert-install:
+cert-install: ## Run mkcert to install CA into system storage and generate default certs for traefik
 	mkcert -install
 	bash mkcert.sh
 .PHONY: cert-install

README.md

@@ -1,11 +1,12 @@
 <br>
 
 <div align="center">
-<img width="456" src="https://raw.githubusercontent.com/wayofdev/docker-php-base/master/assets/logo.gh-light-mode-only.png#gh-light-mode-only">
-<img width="456" src="https://raw.githubusercontent.com/wayofdev/docker-php-base/master/assets/logo.gh-dark-mode-only.png#gh-dark-mode-only">
+<img width="456" src="https://raw.githubusercontent.com/wayofdev/docker-shared-services/master/assets/logo.gh-light-mode-only.png#gh-light-mode-only">
+<img width="456" src="https://raw.githubusercontent.com/wayofdev/docker-shared-services/master/assets/logo.gh-dark-mode-only.png#gh-dark-mode-only">
 </div>
 
 
+
 <br>
 
 <br>
@@ -51,4 +52,109 @@ This repository configures Traefik to run together with, installed in system, dn
   * Can be installed and configured automatically via our own [ansible-role-dnsmasq](https://github.com/wayofdev/ansible-role-dnsmasq)
 
 <br>
-@todo to be continued...
+
+## ⚙️ How to Use
+
+### → Instructions
+
+1. Download repository:
+
+   ```bash
+   $ git clone [email protected]:wayofdev/docker-shared-services.git
+   ```
+
+2. Generate default .env file:
+
+   ```bash
+   $ make env
+   ```
+
+   Edit created .env file, if it is needed. Probably you will want to change default domain.
+
+   Leave blank `SHARED_DOMAIN_SEGMENT`, to run shared services under first level domain, example:
+
+   * router.docker, 
+   * pg-admin.docker, 
+   * ui.docker
+   * etc.
+
+   Or set segment, to run them under subdomain: `SHARED_DOMAIN_SEGMENT=".wod"` Services will run under that segment, example:
+
+   * router**.wod**.docker
+   * pg-admin**.wod**.docker
+   * ui**.wod**.docker
+   * etc
+
+   Don't forget to include first level domains into `TLS_DOMAINS` variable. Default certificates will be created for these domains and wildcards:
+
+   * ui.docker — Included as fallback, if `SHARED_DOMAIN_SEGMENT` was left blank
+   * router.docker — Included as fallback, if `SHARED_DOMAIN_SEGMENT` was left blank
+   * pg-admin.docker — Included as fallback, if `SHARED_DOMAIN_SEGMENT` was left blank
+   * *.wod.docker — All subdomains under this wildcard. Only one level of nesting will work in most of the browsers
+   * *.wod.mac — Same as above wildcard
+
+3. Install root certificate into system and generate default certs:
+   ```bash
+   $ make cert-install
+   ```
+
+4. (Optional) Enable docker-compose.override file to run extra services, like pg-admin and others:
+   ```bash
+   $ make override
+   ```
+
+5. Run this repository:
+
+   ```bash
+   $ make up
+   ```
+
+<br>
+
+### → Outcome
+
+Services will be running under shared docker network, called `ss_shared_network` and all microservices, that will share same network, will be visible for Traefik, and local DNS, served by dnsmasq, will be available.
+
+**Traefik dashboard** — [https://router.wod.docker](https://router.wod.docker/dashboard/#/)
+
+![Alt text](assets/traefik.png?raw=true "Title")
+
+**Portrainer** — https://ui.wod.docker
+
+**Pg-admin** (if docker-compose.override was enabled) — https://pg-admin.wod.docker
+
+<br>
+
+## 🧪 Testing
+
+You can check `Makefile` to get full list of commands for local testing. For testing, you can use these commands to test whole role or separate tasks:
+
+Testing docker-compose using dcgoss:
+
+```bash
+$ make test
+```
+
+<br>
+
+## 🤝 License
+
+[![Licence](https://img.shields.io/github/license/wayofdev/docker-shared-services?style=for-the-badge&color=blue)](./LICENSE)
+
+<br>
+
+## 🙆🏼‍♂️ Author Information
+
+This repository was created in **2022** by [lotyp / wayofdev](https://github.com/wayofdev).
+
+<br>
+
+## 🫡 Contributors
+
+<img align="left" src="https://img.shields.io/github/contributors-anon/wayofdev/docker-shared-services?style=for-the-badge"/>
+
+<a href="https://github.com/wayofdev/docker-nginx/graphs/contributors">
+  <img src="https://opencollective.com/wod/contributors.svg?width=890&button=false">
+</a>
+
+<br>

assets/traefik.png

@@ -1,3 +1,5 @@
+---
+
 version: '3.9'
 
 services:
@@ -47,3 +49,5 @@ networks:
 
 volumes:
   ui_data:
+
+...

docker-compose.yaml

@@ -1,3 +1,5 @@
+---
+
 providers:
   docker:
     exposedByDefault: false
@@ -32,3 +34,5 @@ tls:
       defaultCertificate:
         certFile: /etc/traefik/cert.pem
         keyFile: /etc/traefik/key.pem
+
+...