Skip to content

docs: add getting started guide #75

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.

Sign up for GitHub

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
cyphar merged 2 commits into from
Sep 29, 2026
Merged

docs: add getting started guide #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1906388
README: update intro line
cyphar Sep 29, 2026
a4554a5
docs: add getting started guide
cyphar Sep 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
## quarry ##
## Quarry ##

A [TUF][]-based update system that is solid as bedrock but produces updates
using a protocol that is as dumb as rocks.
A [TUF][]-based software distribution toolchain for immutable Linux
distributions, with a protocol that is "dumb as rocks".

To see how to get started with publishing artefacts and pulling them with the
Quarry client, see our [getting started guide][getting-started]. For more
background on Quarry, take a look at [the announcement blog post][quarry-blog].

[TUF]: https://theupdateframework.io/
[getting-started]: ./docs/getting-started.md
[quarry-blog]: https://amutable.com/blog/distributing-images-quarry

### License ###

Expand Down
Loading
Loading