Skip to content

Commit 375d122

Browse files
authored
Merge pull request #18 from DeterminateSystems/fix-readme
Small README fix
2 parents e48ed81 + 9e94b0d commit 375d122

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@ Use Magic Nix Cache, a totally free and zero-configuration binary cache for Nix
66
Add our [GitHub Action][action] after installing Nix, in your workflow, like this:
77

88
```yaml
9-
- uses: DeterminateSystems/magic-nix-cache-action@main
9+
- uses: DeterminateSystems/magic-nix-cache-action@main
1010
```
1111
1212
See [Usage](#usage) for a detailed example.
1313
1414
## Why use the Magic Nix Cache?
15+
1516
Magic Nix Cache uses the GitHub Actions [built-in cache][ghacache] to share builds between Workflow runs, and has many advantages over alternatives.
1617
1718
1. Totally free: backed by GitHub Actions' cache, there is no additional service to pay for.
@@ -22,9 +23,9 @@ Magic Nix Cache uses the GitHub Actions [built-in cache][ghacache] to share buil
2223
1. Secure: Magic Nix Cache follows the [same semantics as the GitHub Actions cache][semantics], and malicious pull requests cannot pollute your project.
2324
1. Private: The cache is stored in the GitHub Actions cache, not with an additional third party.
2425
25-
> **Note:** the Magic Nix Cache doesn't offer a publically available cache.
26+
> **Note:** the Magic Nix Cache doesn't offer a publicly available cache.
2627
> This means the cache is only usable in CI.
27-
> Zero to Nix has an article on binary caching if you want to [share Nix builds][z2ncache] with users outside of CI.
28+
> [Zero to Nix][z2n] has an article on binary caching if you want to [share Nix builds][z2ncache] with users outside of CI.
2829
2930
## Usage
3031
@@ -71,7 +72,7 @@ When the rate limit is exceeded while uploading to the cache, the remainder of t
7172
This project depends on the GitHub Actions Cache API.
7273
For local development, see `gha-cache/README.md` for more details on how to obtain the required tokens.
7374

74-
```
75+
```shell
7576
cargo run -- -c creds.json --upstream https://cache.nixos.org
7677
cargo build --release --target x86_64-unknown-linux-musl
7778
cargo build --release --target aarch64-unknown-linux-musl
@@ -80,6 +81,7 @@ nix-store --store $PWD/test-root --extra-substituters 'http://localhost:3000' --
8081
```
8182

8283
## Acknowledgement
84+
8385
Magic Nix Cache is a collaboration with [Zhaofeng Li][zhaofeng].
8486
Zhaofeng is a major contributor to the Nix community, having authored [Attic][attic] and [Colmena][colmena].
8587
We'd like to express our deep gratitude to Zhaofeng for his tremendous work on this project.
@@ -124,3 +126,5 @@ You can read the full privacy policy for [Determinate Systems][detsys], the crea
124126
[zhaofeng]: https://github.com/zhaofengli/
125127
[attic]: https://github.com/zhaofengli/attic
126128
[colmena]: https://github.com/zhaofengli/colmena
129+
[z2n]: https://zero-to-nix.com
130+

0 commit comments

Comments
 (0)