diff --git a/README.md b/README.md index 8751d5f..81982a1 100644 --- a/README.md +++ b/README.md @@ -2,5 +2,28 @@ The next-generation master server for Northstar. -TODO: Finish the rest of this README. +## Installation +First install Go from here: [https://go.dev/doc/install](https://go.dev/doc/install) + +Then run the following commands: + +```bash +go run ./cmd/atlas +``` + +## Building + +To build Atlas, run the following command: + +```bash +go build ./cmd/atlas +``` + +## Usage + +Run the `atlas.exe` or directly with `go run ./cmd/atlas` and update your northstar config to point to the new masterserver. + +``` +ns_masterserver_hostname "localhost:8080" +``` \ No newline at end of file