README

celenium-io · Feb 2, 2024 · f39043a · f39043a
1 parent 082a912
commit f39043a
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 6 deletions.
diff --git a/Makefile b/Makefile
@@ -31,4 +31,7 @@ ga:
 license-header:
 	update-license -path=./ -license=./HEADER
 
-.PHONY: indexer api generate test lint cover api-docs ga license-header
+build:
+	docker-compose up -d --build
+
+.PHONY: indexer api generate test lint cover api-docs ga license-header build
diff --git a/README.md b/README.md
@@ -1 +1,22 @@
-# Astria Indexer
+# Astria Indexer
+
+## Standalone
+
+To run indexer clone repository, open directory containing project and run build command. Example:
+
+```bash
+git clone [email protected]:celenium-io/astria-indexer.git
+cd astria-indexer
+make build
+```
+
+or by docker compose
+
+
+```bash
+git clone [email protected]:celenium-io/astria-indexer.git
+cd astria-indexer
+docker-compose up -d --build
+```
+
+You can set environment variables for customizing instances and indexing logic. Example of environment file can be found [here](.env.example).
diff --git a/cmd/api/docs/docs.go b/cmd/api/docs/docs.go
diff --git a/cmd/api/docs/swagger.json b/cmd/api/docs/swagger.json
diff --git a/cmd/api/docs/swagger.yaml b/cmd/api/docs/swagger.yaml
diff --git a/cmd/api/handler/ws_test.go b/cmd/api/handler/ws_test.go
@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: 2024 PK Lab AG <[email protected]>
+// SPDX-License-Identifier: MIT
+
 package handler
 
 import (