chore(README): add installation instrucitons

.github/workflows/build.yml

@@ -23,4 +23,4 @@ jobs:
 
       - name: Build
         run: |
-          go build -o paddler-bin-linux-x64 .
+          make paddler-bin-linux-x64

.gitignore

@@ -1,4 +1,5 @@
 /*.db
 /node_modules
 /paddler
+/paddler-bin-linux-x64
 /snapshots

Makefile

@@ -1,4 +1,4 @@
-.DEFAULT_GOAL := paddler
+.DEFAULT_GOAL := paddler-bin-linux-x64
 
 CSS_SOURCES := \
 	$(wildcard */*.css) \
@@ -13,9 +13,9 @@ GO_SOURCES := \
 # Real targets
 # -----------------------------------------------------------------------------
 
-paddler: $(CSS_SOURCES) $(GO_SOURCES)
+paddler-bin-linux-x64: $(CSS_SOURCES) $(GO_SOURCES)
 	$(MAKE) -C management build
-	go build -o paddler
+	go build -o paddler-bin-linux-x64
 
 # -----------------------------------------------------------------------------
 # Phony targets

README.md

@@ -26,6 +26,22 @@ sequenceDiagram
 
 ## Usage
 
+### Installation
+
+You can download the latest release from the 
+[releases page](https://github.com/distantmagic/paddler/releases).
+
+Alternatively you can build the project yourself. You need `go>=1.21` and
+`node` (for dashboard's front-end code) to build the project.
+
+```shell
+# dashboard front-end
+pushd ./management
+make esbuild
+popd
+go build -o paddler
+```
+
 ### Running Agents
 
 The agent should be installed in the same host as [llama.cpp](https://github.com/ggerganov/llama.cpp).
@@ -57,6 +73,10 @@ Load balancer collects data from agents and exposes reverse proxy to the outside
     --reverseproxy-port 8080
 ```
 
+You can enable dashboard to see the status of the agents with 
+`--management-dashboard-enable=true` flag. If enabled it is available at the 
+management server address under `/dashboard` path.
+
 ## Roadmap
 
 - [x] [llama.cpp](https://github.com/ggerganov/llama.cpp) reverse proxy

management/Makefile

@@ -20,6 +20,8 @@ build: esbuild
 
 .PHONY: clean
 clean:
+	rm -rf esbuild-meta-mgmt.json
+	rm -rf static
 	rm -rf node_modules
 
 .PHONY: esbuild