diff --git a/README.md b/README.md index 7f74b11..c2009af 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ - + > C Websocket Server [![MIT License](https://img.shields.io/badge/license-MIT-007EC7.svg?style=flat-square)](/LICENSE) -

+
## Table of Contents * Introduction @@ -16,6 +16,15 @@ This websocket server parses JSON data sent by the client in order to control the state of GPIO pins by writing them to a SQL database. +## Installation +1. Clone the repo using git (`git clone https://github.com/Wessel/c-websocket-server`) +2. Install dependencies using desired package manager (`yay -S libmysqlclient json-c`) +3. Build and run the project (`make clean run`) + +Or using Docker: +1. Build the container (`docker build -t c-websocket-server .`) +2. Start the container (`docker run -dp 127.0.0.1:8080:8080 c-websocket-server` + ## Libraries [argp](https://www.gnu.org/software/libc/manual/html_node/Argp.html) is used