Heretek-AI/arcane-repo
1
0
Fork 0
mirror of https://github.com/Heretek-AI/arcane-repo.git synced 2026-07-01 18:25:50 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: Polished README.md — removed early dev status, added CI badges fo…

Browse Source 
- README.md

GSD-Task: S04/T02
This commit is contained in:
John Doe
2026-04-29 17:17:56 -04:00
parent 226e3006ed
commit 8b877dafea
1 changed files with 17 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -5
View File
@@ -2,11 +2,10 @@
A curated registry of Docker Compose templates for Arcane. Template folders serve as the single source of truth — CI validates their structure, assembles `registry.json` from on-disk state, and publishes it to GitHub Pages. No manual registry edits, no stale entries, no sync drift between folders and the index.
> **Status:** Early development. Structure and CI are being established.
## Badges
<!-- TODO: Add CI status badge once GitHub Actions are configured -->
![Validate](https://github.com/Heretek-AI/arcane-repo/actions/workflows/validate.yml/badge.svg)
![Deploy](https://github.com/Heretek-AI/arcane-repo/actions/workflows/deploy.yml/badge.svg)
## Quick Start
@@ -15,8 +14,21 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for how to add, modify, or remove templat
## How It Works
1. Each template lives in its own directory under `templates/` with an `arcane.json` metadata file and a `docker-compose.yml`.
2. A CI workflow (`build-registry.yml`) runs the `scripts/build-registry.js` script, which reads each template folder, validates it against `schema.json`, and produces `registry.json`.
3. The generated `registry.json` is deployed to GitHub Pages for consumption by Arcane clients.
2. All **6 templates** are available — see the [Templates](#templates) section below.
3. A CI workflow (`validate.yml`) runs on every PR touching `templates/**`, executing `node scripts/build-registry.js --validate-only` to check structure, metadata, and file integrity.
4. On push to `main`, the `deploy.yml` workflow runs `node scripts/build-registry.js` to assemble `registry.json` and publishes it to GitHub Pages.
5. The generated `registry.json` is consumed by Arcane clients. No manual registry edits, no stale entries, no sync drift between folders and the index.
## Templates
| Template | Description |
|----------|-------------|
| [Ollama](templates/ollama/) | Run large language models locally with persistent storage and optional GPU acceleration. |
| [LiteLLM](templates/litellm/) | Unified AI API proxy providing an OpenAI-compatible endpoint for 100+ LLM providers. |
| [n8n](templates/n8n/) | Fair-code workflow automation with 400+ integrations and AI agent capabilities. |
| [Dify](templates/dify/) | Open-source platform for building AI apps with visual workflows, RAG pipelines, and custom chatbots. |
| [LangChain](templates/langchain/) | LangServe API server deploying LangChain chains and runnables as REST APIs. |
| [OpenClaw](templates/openclaw/) | Foundation template for a community and event platform API server (Node.js + PostgreSQL). |
## License