• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

cameri / nostream / 44570856473
80%

Build:
DEFAULT BRANCH: main
Ran 19 Nov 2026 04:56PM UTC
Jobs 2
Files 341
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

19 Nov 2026 04:51PM UTC coverage: 79.447% (-0.004%) from 79.451%
44570856473

push

github

web-flow
docs: split the README into a landing page and reference guides (#1175)

The README had grown to 731 lines and carried three things that belong
in their own guides: a full payments walkthrough, an operations manual,
and a duplicate of the standalone setup steps that CONTRIBUTING.md
already documents. A reader looking for "how do I run this" had to
scroll past a Lightning processor setup to find it.

It is now 264 lines and answers one question: what is the relay and how
do I start it. Everything else is one click away in a table at the top.

## Where things went

| Was in README | Now |
| --- | --- |
| Accepting Payments (108 lines) | [docs/PAYMENTS.md](docs/PAYMENTS.md)
|
| Running as a Service, Export Events, Benchmark Database Queries, Relay
Maintenance, Troubleshooting (199 lines) |
[docs/OPERATIONS.md](docs/OPERATIONS.md) |
| Quick Start (Standalone) (96 lines) | already documented in
[CONTRIBUTING.md](CONTRIBUTING.md#development-quick-start-standalone);
README now points there |
| Importing events (45 lines) |
[docs/OPERATIONS.md#importing-events](docs/OPERATIONS.md#importing-events),
with a one-line pointer in the quick start |
| Legacy `scripts/` wrapper table (14 lines) | already in
[CLI.md](CLI.md#removed-legacy-wrappers) |
| NIP-43 invite-code walkthrough (14 lines) | already in
[CLI.md](CLI.md#nip-43-invite-codes) |

Text that moved was moved verbatim — the sections were extracted from
the old README rather than retyped, and `## Configuration` keeps its
existing pointer to CONFIGURATION.md. The features list, requirements,
the Docker quick start, the developer channel, the author, the
contributor list, the license and the star history chart stay where they
were.

## Checks

- Every relative link in the README and the two new guides resolves to a
file that exists, and the three in-document anchors
(`CLI.md#nip-43-invite-codes`,
`CONTRIBUTING.md#development-quick-start-standalone`,
`docs/OPERATIONS.md#importing-events`) match their headings.... (continued)

5576 of 7618 branches covered (73.2%)

Branch coverage included in aggregate %.

11687 of 14111 relevant lines covered (82.82%)

668.09 hits per line

Jobs
ID Job ID Ran Files Coverage
1 Integration - 44570856473.1 19 Nov 2026 04:56PM UTC 341
35.15
GitHub Action Run
2 Unit - 44570856473.2 19 Nov 2026 04:56PM UTC 341
77.37
GitHub Action Run
Source Files on build 44570856473
  • Tree
  • List 341
  • Changed 1
  • Source Changed 0
  • Coverage Changed 1
Coverage ∆ File Lines Relevant Covered Missed Hits/Line Branch Hits Branch Misses
  • Back to Repo
  • Github Actions Build #44570856473
  • 62241323 on github
  • Prev Build on main (#44435172796)
  • Next Build on main (#44772541683)
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE TRIAL · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc