Skip to content
This repository was archived by the owner on Feb 15, 2026. It is now read-only.

docs: fix README inconsistencies and outdated info #5

Merged
NicolasRitouet merged 1 commit into from
Jan 21, 2026
Merged

docs: fix README inconsistencies and outdated info #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ brew install keywaysh/tap/keyway
### Install Script

```bash
curl -fsSL https://get.keyway.sh | sh
curl -fsSL https://keyway.sh/install.sh | sh
```

### npx (no install)
Expand Down Expand Up @@ -85,7 +85,7 @@ Never write secrets to disk. Inject them directly into your process:

```bash
keyway run -- npm start
keyway run --env production -- ./my-app
keyway run -e production -- ./my-app
```

Secrets exist only in memory. When the process exits, they're gone.
Expand Down Expand Up @@ -135,7 +135,7 @@ We can't read your secrets. Even if our database leaks, attackers get encrypted

| Variable | Description |
|----------|-------------|
| `KEYWAY_TOKEN` | Auth token for CI/CD (use `keyway login --ci`) |
| `KEYWAY_TOKEN` | Auth token for CI/CD (create in Dashboard > API Keys) |
| `KEYWAY_API_URL` | Custom API endpoint |
| `KEYWAY_DISABLE_TELEMETRY=1` | Disable anonymous analytics |

Expand Down Expand Up @@ -163,7 +163,7 @@ Use an API key for automation:
# GitHub Actions example
env:
KEYWAY_TOKEN: ${{ secrets.KEYWAY_TOKEN }}
run: keyway pull --env production
run: keyway pull -e production
```

Or use the [GitHub Action](https://github.com/keywaysh/keyway-action):
Expand Down
8 changes: 4 additions & 4 deletions npm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ brew install keywaysh/tap/keyway
### Install Script

```bash
curl -fsSL https://get.keyway.sh | sh
curl -fsSL https://keyway.sh/install.sh | sh
```

### npx (no install)
Expand Down Expand Up @@ -85,7 +85,7 @@ Never write secrets to disk. Inject them directly into your process:

```bash
keyway run -- npm start
keyway run --env production -- ./my-app
keyway run -e production -- ./my-app
```

Secrets exist only in memory. When the process exits, they're gone.
Expand Down Expand Up @@ -135,7 +135,7 @@ We can't read your secrets. Even if our database leaks, attackers get encrypted

| Variable | Description |
|----------|-------------|
| `KEYWAY_TOKEN` | Auth token for CI/CD (use `keyway login --ci`) |
| `KEYWAY_TOKEN` | Auth token for CI/CD (create in Dashboard > API Keys) |
| `KEYWAY_API_URL` | Custom API endpoint |
| `KEYWAY_DISABLE_TELEMETRY=1` | Disable anonymous analytics |

Expand Down Expand Up @@ -163,7 +163,7 @@ Use an API key for automation:
# GitHub Actions example
env:
KEYWAY_TOKEN: ${{ secrets.KEYWAY_TOKEN }}
run: keyway pull --env production
run: keyway pull -e production
```

Or use the [GitHub Action](https://github.com/keywaysh/keyway-action):
Expand Down
Loading