Skip to content

Commit 6a782ae

Browse files
committed
README typos and wording tweaks
1 parent a8ececb commit 6a782ae

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ This will show the raw content as stored in the repository. So even if `cat my-s
138138

139139
### Unlock a repository
140140

141-
After you freshly clone a repository which contains files which have been encrypted by `git-conceal`, you need to provide the symmetric key that your coworkers would have shared with you to decrypt it:
141+
After you freshly clone a repository which contains files which have been encrypted by `git-conceal`, you need to provide the symmetric key (that your coworkers would have shared with you) to decrypt it:
142142

143143
```bash
144144
# Option 1: Provide the Base64-encoded key directly as command line argument.
@@ -189,7 +189,7 @@ git-conceal status
189189
This shows:
190190
- Whether the repository is locked or unlocked
191191
- Whether filters are configured
192-
- Which file patterns are encrypted (from `.gitattributes`)
192+
- Which files are handled by `git-conceal` (i.e. tracked files matching one of the patterns with `filter=git-conceal` in your `.gitattributes`)
193193

194194
```bash
195195
git-conceal status <FILES>
@@ -208,7 +208,7 @@ git-conceal key show
208208
### Rotate the encryption key
209209

210210
There are times when you might need to rotate the encryption key used in an encrypted repository.
211-
For example, in the unfortunate even of the key leaking or when a coworker leaves your team/company and you want to ensure they can't access new secrets.
211+
For example, in the unfortunate event of the key leaking, or when a coworker leaves your team/company and you want to ensure they can't access new secrets.
212212

213213
You can rotate the encryption key with:
214214

@@ -248,15 +248,19 @@ For detailed security information, including key management, deterministic encry
248248

249249
## New releases
250250

251-
Releases are automated by our CI every time we make a `git tag` on the repo. Be sure to update the version in the `Cargo.toml` first though.
251+
Releases are automated by our CI every time we make a `git tag` on the repo.
252+
253+
<details><summary>Release instructions for maintainers</summary>
252254

253255
- Create a `release/x.y.z` branch
254256
- Edit `Cargo.toml` to update the `version = "x.y.z"` field
255-
- Run `cargo check` to update the `Cargo.lock` and validate the code still compiles
257+
- Run `cargo check` to update the `Cargo.lock` with the new version and validate the code still compiles
256258
- `git add Cargo.toml Cargo.lock` then `git commit -m "Bump version to x.y.z"`
257-
- Create a PR and get it merged
259+
- Create a PR with those changes and get it merged into `trunk`
258260
- Once it has landed in `trunk`, push a new tag (`git tag "x.y.z"` then `git push origin "x.y.z"`)
259-
- Then let the CI build the release binaries for all platforms, create the GitHub Release, and attach the compiled binaries as assets.
261+
262+
The CI will trigger on the Git tag and take care of building the release binaries for all platforms and creating the GitHub Release with those binaries attached as assets.
263+
</details>
260264

261265
## License
262266

0 commit comments

Comments
 (0)