docs(readme): rewrite README with a short overview and docs/ (#11)
- commit
- 69496372722f09c8b6245a5e17d7c28026bfc039
- author
- brice · · 2026-10-18 17:43 UTC
- committer
- bnema · · 2026-10-18 17:43 UTC
- parent
- 3118ae6
- signature
- SSH Unverified
SHA256:VOCA5lYARHcbKDZ7GhTV45VmcjWnJ6ZQIBazj17LivAThe key is unknown
1 file · +19 -3
M README.md +19 -3
| @@ -1,10 +1,26 @@ | |||
| 1 | - | # ermite-actions | |
| 1 | + | <h1 align="center">ermite-actions</h1> | |
| 2 | + | ||
| 3 | + | <p align="center"> | |
| 4 | + | <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="License: MIT"></a> | |
| 5 | + | <a href="https://github.com/bnema/ermite-actions/commits/main"><img src="https://badgen.net/github/last-commit/bnema/ermite-actions/main?icon=github" alt="Last commit"></a> | |
| 6 | + | <a href="https://github.com/bnema/ermite-actions/stargazers"><img src="https://badgen.net/github/stars/bnema/ermite-actions?icon=github" alt="GitHub stars"></a> | |
| 7 | + | </p> | |
| 8 | + | ||
| 9 | + | <p align="center">The GitHub Actions workflow language in Go.</p> | |
| 2 | 10 | ||
| 3 | 11 | > Read-only mirror. Development happens at git.bnema.dev; issues and pull requests are closed here. | |
| 4 | 12 | ||
| 5 | - | The GitHub Actions workflow language in Go: expressions `${{ }}`, template tokens and the workflow schema, the workflow model, matrices, job graphs and trigger filters, and `action.yml` manifests (`action`) with the `uses:` parser. [ermite](https://github.com/bnema/ermite) plans runs with it and [ermite-runner](https://github.com/bnema/ermite-runner) executes jobs with it. | |
| 13 | + | --- | |
| 14 | + | ||
| 15 | + | ## What it covers | |
| 16 | + | ||
| 17 | + | - Expressions `${{ }}`, template tokens and the workflow schema | |
| 18 | + | - Workflow model, matrices, job graphs and trigger filters | |
| 19 | + | - `action.yml` manifests and the `uses:` parser | |
| 20 | + | ||
| 21 | + | [ermite](https://github.com/bnema/ermite) plans runs with it; [ermite-runner](https://github.com/bnema/ermite-runner) executes jobs with it. | |
| 6 | 22 | ||
| 7 | - | The goal is GitHub's exact behaviour. Semantics and test cases come from GitHub's MIT sources ([actions/languageservices](https://github.com/actions/languageservices), [actions/runner](https://github.com/actions/runner)); see [THIRD_PARTY.md](THIRD_PARTY.md). | |
| 23 | + | The target is GitHub's exact behaviour. Semantics and test cases come from GitHub's MIT sources ([actions/languageservices](https://github.com/actions/languageservices), [actions/runner](https://github.com/actions/runner)). See [THIRD_PARTY.md](THIRD_PARTY.md). | |
| 8 | 24 | ||
| 9 | 25 | Status: early development, no stable API. | |
| 10 | 26 | ||
| @@ -1,10 +1,26 @@ | |||||
| 1 | - | # ermite-actions | 1 | + | <h1 align="center">ermite-actions</h1> |
| 2 | + | ||||
| 3 | + | <p align="center"> | |||
| 4 | + | <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="License: MIT"></a> | |||
| 5 | + | <a href="https://github.com/bnema/ermite-actions/commits/main"><img src="https://badgen.net/github/last-commit/bnema/ermite-actions/main?icon=github" alt="Last commit"></a> | |||
| 6 | + | <a href="https://github.com/bnema/ermite-actions/stargazers"><img src="https://badgen.net/github/stars/bnema/ermite-actions?icon=github" alt="GitHub stars"></a> | |||
| 7 | + | </p> | |||
| 8 | + | ||||
| 9 | + | <p align="center">The GitHub Actions workflow language in Go.</p> | |||
| 2 | 10 | ||||
| 3 | > Read-only mirror. Development happens at git.bnema.dev; issues and pull requests are closed here. | 11 | > Read-only mirror. Development happens at git.bnema.dev; issues and pull requests are closed here. | ||
| 4 | 12 | ||||
| 5 | - | The GitHub Actions workflow language in Go: expressions `${{ }}`, template tokens and the workflow schema, the workflow model, matrices, job graphs and trigger filters, and `action.yml` manifests (`action`) with the `uses:` parser. [ermite](https://github.com/bnema/ermite) plans runs with it and [ermite-runner](https://github.com/bnema/ermite-runner) executes jobs with it. | 13 | + | --- |
| 14 | + | ||||
| 15 | + | ## What it covers | |||
| 16 | + | ||||
| 17 | + | - Expressions `${{ }}`, template tokens and the workflow schema | |||
| 18 | + | - Workflow model, matrices, job graphs and trigger filters | |||
| 19 | + | - `action.yml` manifests and the `uses:` parser | |||
| 20 | + | ||||
| 21 | + | [ermite](https://github.com/bnema/ermite) plans runs with it; [ermite-runner](https://github.com/bnema/ermite-runner) executes jobs with it. | |||
| 6 | 22 | ||||
| 7 | - | The goal is GitHub's exact behaviour. Semantics and test cases come from GitHub's MIT sources ([actions/languageservices](https://github.com/actions/languageservices), [actions/runner](https://github.com/actions/runner)); see [THIRD_PARTY.md](THIRD_PARTY.md). | 23 | + | The target is GitHub's exact behaviour. Semantics and test cases come from GitHub's MIT sources ([actions/languageservices](https://github.com/actions/languageservices), [actions/runner](https://github.com/actions/runner)). See [THIRD_PARTY.md](THIRD_PARTY.md). |
| 8 | 24 | ||||
| 9 | Status: early development, no stable API. | 25 | Status: early development, no stable API. | ||
| 10 | 26 | ||||