Skip to content

Commit 1387d45

Browse files
committed
Update readme.
1 parent 10cb066 commit 1387d45

1 file changed

Lines changed: 16 additions & 11 deletions

File tree

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ First, check your Ruby estate (by default checking at `~/.rubies`, see `--help`
3333

3434
```bash
3535
# Survey your distinguished Ruby installations
36-
rb runtime
36+
rb info runtime
3737
```
3838

3939
Ruby Butler composes gem and bundle commands with environmental intelligence:
@@ -85,16 +85,21 @@ Ruby Butler expects Ruby installations in `~/.rubies/` (the standard location fo
8585

8686
## Commands
8787

88-
- `rb runtime` / `rb rt` - Survey your Ruby estate with elegant presentation
8988
- `rb exec` / `rb x` - Execute commands within meticulously prepared environments
90-
- `rb environment` / `rb env` - Display current environment composition
91-
- `rb sync` - Manually synchronize bundler environments (auto-triggered when needed)
92-
- `rb run` / `rb r` - Execute project scripts defined in `gem.toml` or `rbproject.toml`
89+
- `rb sync` / `rb s` - Synchronize bundler environments (also auto-triggered when needed)
90+
- `rb run` / `rb r` - Execute project scripts defined in `rbproject.toml`
91+
- `rb new` - Create a minimal `rbproject.toml` in the current directory
92+
- `rb info runtime` - Survey your Ruby estate with elegant presentation
93+
- `rb info env` - Display current environment composition
94+
- `rb info project` - Show resolved project settings
95+
- `rb info config` - Display merged configuration with sources
96+
- `rb version` - Display version information
97+
- `rb shell-integration bash` - Generate bash completions (`eval "$(rb shell-integration bash)"`)
9398

9499
## Configuration
95100

96-
- **`rb.toml`** - Global configuration file (in `%APPDATA%/rb/` or `~/.rb.toml`)
97-
- **`gem.toml`** or **`rbproject.toml`** - Project-level script definitions and metadata
101+
- **`rb.toml`** - Global configuration file (in `~/.config/rb/` or `~/.rb.toml`)
102+
- **`rbproject.toml`** or **`gem.toml`** - Project-level script definitions and metadata
98103

99104
## Development
100105

@@ -134,13 +139,13 @@ Invoke-Pester tests/
134139

135140
Ruby Butler is built with Rust for cross-platform reliability and employs a **environment-agnostic** design—no shell modifications required.
136141

137-
If you're curious about what Butler does under the hood, add `-v` or even better `-vv` to see the distinguished orchestration in action.
142+
If you're curious about what Butler does under the hood, add `-v` or `-V` to see the distinguished orchestration in action.
138143

139144
## Release Process
140145

141146
To create a new release with cross-platform binaries:
142147

143-
1. **Update version** in `crates/rb-cli/Cargo.toml`
148+
1. **Update version** in root `Cargo.toml` (workspace version)
144149
2. **Update CHANGELOG.md** with release notes
145150
3. **Create and push tag**:
146151
```bash
@@ -149,9 +154,9 @@ To create a new release with cross-platform binaries:
149154
```
150155

151156
The release workflow automatically:
152-
- Builds binaries for Linux, macOS, and Windows (both release and debug)
157+
- Builds binaries for Linux, macOS (ARM64), and Windows (both release and debug)
153158
- Creates GitHub release with binaries attached
154-
- Embeds git information in version output (`rb --version`)
159+
- Embeds git information in version output (`rb version`)
155160

156161
Released binaries include version traceability:
157162
- **Tagged builds**: `Ruby Butler v1.0.0`

0 commit comments

Comments
 (0)