docs: add project README and license

2026-07-11 19:04:01 +08:00
parent dd1e873408
commit 40a7f35662
3 changed files with 56 additions and 10 deletions
@@ -1,22 +1,34 @@
-# Binaries
+# Go
 bin/
 dist/
 *.exe
-*.dll
-*.so
-*.dylib
-
-# Build output
+*.test
 coverage.out

+# Dependencies
+vendor/
+
 # IDE
 .vscode/
 .idea/

-# OS
-.DS_Store
-Thumbs.db
+# Logs
+*.log

 # Environment
 .env
-.env.local
+
+# Certificates
+*.pem
+*.key
+
+# Kubernetes Secrets
+*.secret.yaml
+
+# Terraform
+.terraform/
+terraform.tfstate*
+
+# OS
+.DS_Store
+Thumbs.db
@@ -0,0 +1,5 @@
+MIT License
+
+Copyright (c) 2026 ETSB Cloud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy...
@@ -0,0 +1,29 @@
+# ORION Telemetry
+
+Telemetry microservice for the ORION Platform.
+
+## Features
+
+- Prometheus Metrics
+- Health Checks
+- Structured Logging
+- Kubernetes Ready
+- Docker Ready
+
+## Tech Stack
+
+- Go
+- Gin
+- Prometheus
+- Kubernetes
+- Harbor
+- Gitea
+
+## Build
+
+go build ./...
+
+## Run
+
+go run ./cmd/server
+