From 20c812e0daafaf26d34748d42740e96005e3bdf4 Mon Sep 17 00:00:00 2001 From: Jacob Gunther Date: Wed, 9 Mar 2022 17:17:12 -0600 Subject: [PATCH] Update README --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 32ac9eb..b21f82f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ # API Server -The REST server that powers the API for mineatar.io. \ No newline at end of file + +The API and rendering service responsible for serving images for mineatar.io. + +## Getting Started + +```bash + +# Clone the repository into a `api-server` folder +git clone https://github.com/mineatar-io/api-server.git + +# Navigate the working directory into the api-server folder +cd api-server + +# Copy the `config.example.yml` file a new file `config.yml` +# You will need to edit the details of this file for proper functionality +cp config.example.yml config.yml + +# Install the Go dependencies +go get ... + +# Build the source code into a single executable +./scripts/build + +# Run the executable +./bin/main +``` + +## Issues + +If you find any issues with this API service (not the website itself), please create a [new issue](https://github.com/mineatar-io/api-server/issues) with all necessary details. + +## Copyright +© 2022 Jacob Gunther \ No newline at end of file