Update README to clarify code block formatting for diagrams and shell commands
- Changed code block syntax from generic to specific types (`diagram` and `shell`) for better readability. - Enhanced the presentation of secrets storage and organization examples.
This commit is contained in:
parent
e347e73976
commit
cc647b922f
1 changed files with 2 additions and 2 deletions
|
|
@ -16,7 +16,7 @@ People end up sharing secrets over Slack, email, or sticky notes. When a key cha
|
||||||
|
|
||||||
`secrets` encrypts your secret files and stores them in a separate, private git repository. Only someone with the encryption key can read them.
|
`secrets` encrypts your secret files and stores them in a separate, private git repository. Only someone with the encryption key can read them.
|
||||||
|
|
||||||
```
|
```diagram
|
||||||
Your project (e.g. ~/myapp/) Your secrets store (~/.secrets/)
|
Your project (e.g. ~/myapp/) Your secrets store (~/.secrets/)
|
||||||
┌──────────────────────────┐ ┌──────────────────────────┐
|
┌──────────────────────────┐ ┌──────────────────────────┐
|
||||||
│ .env (plaintext)│──encrypt─▶│ myapp/.env.age (encrypted)│──sync──▶ GitHub (private)
|
│ .env (plaintext)│──encrypt─▶│ myapp/.env.age (encrypted)│──sync──▶ GitHub (private)
|
||||||
|
|
@ -198,7 +198,7 @@ secrets run -w turbo dev # pull all, run command, clear all on exit
|
||||||
|
|
||||||
Inside `~/.secrets/`, workspace secrets are organized by path:
|
Inside `~/.secrets/`, workspace secrets are organized by path:
|
||||||
|
|
||||||
```
|
```shell
|
||||||
~/.secrets/
|
~/.secrets/
|
||||||
myapp/
|
myapp/
|
||||||
.env.age # root project secrets
|
.env.age # root project secrets
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue