diff --git a/wap/mac-check/README.md b/wap/mac-check/README.md index d53c48f..a69f6eb 100644 --- a/wap/mac-check/README.md +++ b/wap/mac-check/README.md @@ -6,6 +6,8 @@ API na zjištovaní zda je mac addressa přiřazená k vyrobci, po případě k Aplikace běží na Node.JS +Demo Url: [mac-check.starraria.eu](https://mac-check.starraria.eu) + ## API ### GET /api @@ -19,4 +21,17 @@ Vratí mac adresu s výrobcem pokud byl nalezen, jinak vratí chybu. **Query Parameters** || Required | Default Value | Desc | |--|--|--|--| -| `format` | `no` | `json` | Specifikuje jaký formát má být použit při odpovědi. Možnosti jsou: `json`,`xml`,`csv` | \ No newline at end of file +| `format` | `no` | `json` | Specifikuje jaký formát má být použit při odpovědi. Možnosti jsou: `json`,`xml`,`csv` | + +## Quick start (On linux) +```bash +git clone https://github.com/Dzejkobik007/skolavdf.git +mv skolavdf/wap/mac-check ./ +rm -rf skolavdf +cd mac-check/ +docker-compose up -d --build +``` + +## Requirements +- docker +- docker-compose