Repository navigation
docs(readme): apply the README presentation standard to the org profile #10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
e778077
docs(readme): apply the README presentation standard to the org profile
lusoris 8a86377
Merge remote-tracking branch 'origin/main' into docs/readme-standard
lusoris 710db0c
docs(profile): link each claim and drop the dead app links
lusoris 8eb6642
docs(profile): add the Best Practices, Codacy and CodeRabbit badges
lusoris 6800305
docs(profile): state the commit rules CONTRIBUTING.md sets
lusoris 6afdc8e
docs(profile): state commit signing and sign-off separately
lusoris ce5005e
Merge remote-tracking branch 'origin/main' into docs/readme-standard
lusoris 7ff358f
docs(profile): link the licence badge to both licences
lusoris File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,103 @@ | ||
| # golusoris | ||
| <!-- markdownlint-disable MD013 MD023 MD033 MD036 MD041 --> | ||
| <!-- A centred header needs inline HTML, a banner image, indented headings and | ||
| badge lines past 80 columns, so those five rules are off for this file. | ||
| Same directive style as docs/adr/0000-template.md. The prose below still | ||
| wraps at 80. --> | ||
| <div align="center"> | ||
|
|
||
| Foundational Go libraries + the apps built on top of them. | ||
| <img src="golusoris-readme-banner.svg" alt="golusoris — foundational Go libraries and applications" height="120" /> | ||
|
|
||
| ## What's here | ||
| <!-- README-STANDARD badge block: one group, fixed order (docs/README-STANDARD.md) --> | ||
| <!-- 2 CI/build --> | ||
| [](https://github.com/golusoris/.github/actions/workflows/reuse.yml) | ||
| <!-- 3 security/scorecard --> | ||
| [](https://scorecard.dev/viewer/?uri=github.com/golusoris/.github) | ||
| [](https://www.bestpractices.dev/projects/16160) | ||
| [](https://app.codacy.com/gh/golusoris/.github/dashboard) | ||
| [](https://coderabbit.ai) | ||
| <!-- 4 standards --> | ||
| [](https://github.com/golusoris/.github/blob/main/AGENTS.md) | ||
| [](https://github.com/golusoris/.github/blob/main/CONTRIBUTING.md) | ||
| <!-- 5 licence --> | ||
| [](https://github.com/golusoris/.github/blob/main/profile/README.md#upstream-and-licence) | ||
| <!-- 6 support --> | ||
| [](https://github.com/sponsors/lusoris) | ||
| [](https://ko-fi.com/lusoris) | ||
|
|
||
| **Foundational Go libraries and the applications built on top of them** | ||
|
|
||
| *The central [framework modules](https://github.com/golusoris/golusoris), [service clients](https://github.com/golusoris/goenvoy), and self-hosted apps of the golusoris ecosystem* | ||
|
|
||
| </div> | ||
|
|
||
| golusoris provides foundational Go libraries and the suite of applications built | ||
| on top of them. It encompasses [composable framework modules covering core | ||
| backend infrastructure](https://github.com/golusoris/golusoris) using Uber's | ||
| [`fx`](https://github.com/uber-go/fx) dependency-injection framework, | ||
| [zero-dependency typed clients for media automation and metadata | ||
| services](https://github.com/golusoris/goenvoy), and self-hosted applications | ||
| built on both, listed under Apps. | ||
|
|
||
| --- | ||
|
|
||
| ## At a glance | ||
|
|
||
| ### Libraries | ||
|
|
||
| - **[golusoris/golusoris](https://github.com/golusoris/golusoris)** — the framework: composable `fx` modules covering config, logging, errors, database, HTTP, OTel, jobs, cache, auth, k8s runtime, notifications, storage, AI, and more. | ||
| - **[golusoris/goenvoy](https://github.com/golusoris/goenvoy)** — typed clients for the *arr stack, metadata services (TMDB, AniList, Trakt, …), and download/indexer APIs. 60+ zero-dependency modules. | ||
|
|
||
| ### Apps | ||
| All apps are built on the `golusoris` framework and live here with the `app-` prefix: | ||
|
|
||
| - **[app-revenge](https://github.com/golusoris/app-revenge)** — high-performance Go media server | ||
| - **[app-lurkarr](https://github.com/golusoris/app-lurkarr)** — automated media hunting for *arr apps | ||
| - **[app-subdo](https://github.com/golusoris/app-subdo)** — visual flow editor for media processing automation | ||
| - **[app-arca](https://github.com/golusoris/app-arca)** — self-hosted ROM management platform | ||
| All apps are built on the `golusoris` framework. Their repositories are not | ||
| published yet; each will use the `app-` prefix here: | ||
|
|
||
| - **app-revenge** — high-performance Go media server | ||
| - **app-lurkarr** — automated media hunting for *arr apps | ||
| - **app-subdo** — visual flow editor for media processing automation | ||
| - **app-arca** — self-hosted ROM management platform | ||
|
|
||
| ## Naming convention | ||
|
|
||
| | Prefix | Kind | Example | | ||
| |---|---|---| | ||
| | --- | --- | --- | | ||
| | none | library | `golusoris/goenvoy` | | ||
| | `app-` | application consuming the framework | `golusoris/app-revenge` | | ||
| | `cmd-` | standalone CLI (future) | `golusoris/cmd-…` | | ||
|
|
||
| The namesake repo `golusoris/golusoris` is the framework itself. | ||
|
|
||
| ## Contribute | ||
|
|
||
| Start with [CONTRIBUTING.md](https://github.com/golusoris/.github/blob/main/CONTRIBUTING.md) | ||
| for contribution guidelines, signing expectations, and Conventional Commits conventions. | ||
| Report vulnerabilities privately as described in [SECURITY.md](https://github.com/golusoris/.github/blob/main/SECURITY.md). | ||
|
|
||
| ## Support | ||
|
|
||
| <p align="left"> | ||
| <a href="https://ko-fi.com/lusoris" target="_blank"> | ||
| <img src="https://ko-fi.com/img/githubbutton_sm.svg" alt="Support me on Ko-fi" /> | ||
| </a> | ||
| | ||
| <a href="https://github.com/sponsors/lusoris" target="_blank"> | ||
| <img src="https://img.shields.io/badge/Sponsor-%E2%9D%A4-ea4aaa?style=for-the-badge&logo=github&logoColor=white" alt="GitHub Sponsors" /> | ||
| </a> | ||
| </p> | ||
| golusoris is free and open source. Support ongoing development, maintenance, and | ||
| infrastructure costs: | ||
|
|
||
| - **[GitHub Sponsors](https://github.com/sponsors/lusoris)** (sponsors/lusoris) | ||
| - **[Ko-fi](https://ko-fi.com/lusoris)** (lusoris) | ||
|
|
||
| ## Upstream and licence | ||
|
|
||
| Code and workflows in this repository are licensed under the European Union Public | ||
| Licence v. 1.2 ([`EUPL-1.2`](https://github.com/golusoris/.github/blob/main/LICENSE)). | ||
| Markdown prose and documentation files are licensed under Creative Commons | ||
| Attribution-ShareAlike 4.0 International ([`CC-BY-SA-4.0`](https://github.com/golusoris/.github/blob/main/LICENSES/CC-BY-SA-4.0.txt)) | ||
| per [`REUSE.toml`](https://github.com/golusoris/.github/blob/main/REUSE.toml). | ||
|
|
||
| ## Standards & Governance | ||
|
|
||
| The `golusoris/.github` repository declares the 21 invariants of the | ||
| High-Integrity Systems Standard (HISS) from | ||
| [Praetor](https://github.com/cordanaLLM/praetor) in | ||
| [`AGENTS.md`](https://github.com/golusoris/.github/blob/main/AGENTS.md). Its | ||
| table names the check that enforces each invariant and marks the invariants | ||
| that are advisory only. Pull request titles follow Conventional Commits. Every | ||
| commit carries a cryptographic signature (`git commit -S`) and, separately, a | ||
| `Signed-off-by` trailer (`git commit -s`), as | ||
| [`CONTRIBUTING.md`](https://github.com/golusoris/.github/blob/main/CONTRIBUTING.md) | ||
| describes. | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.