Skip to content

Commit a7dfd79

Browse files
committed
docs: refresh README for 0.1.1
1 parent a35093f commit a7dfd79

4 files changed

Lines changed: 20 additions & 20 deletions

File tree

CHANGELOG.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ All notable changes to this project will be documented in this file. The format
66

77
_Nothing yet._
88

9+
## [0.1.1] - 2025-10-04
10+
11+
### Changed
12+
13+
- Polished `README.md`: added a crates.io badge, fixed heading spacing, and corrected typos so the documentation shown on crates.io matches the repository.
14+
915
## [0.1.0] - 2025-10-03
1016

1117
### Added
@@ -24,5 +30,6 @@ _Nothing yet._
2430
- `-c/--code` and `-f/--file` flags are accepted immediately after the language selector without consuming snippet text.
2531
- Added regression coverage ensuring `run python -c` continues to consume piped input in future releases.
2632

27-
[Unreleased]: https://github.com/Esubaalew/run/compare/v0.1.0...HEAD
33+
[Unreleased]: https://github.com/Esubaalew/run/compare/v0.1.1...HEAD
34+
[0.1.1]: https://github.com/Esubaalew/run/compare/v0.1.0...v0.1.1
2835
[0.1.0]: https://github.com/Esubaalew/run/releases/tag/v0.1.0

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "run-kit"
3-
version = "0.1.0"
3+
version = "0.1.1"
44
edition = "2024"
55
description = "Universal multi-language runner and smart REPL"
66
license = "Apache-2.0"

README.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
<a href="https://github.com/Esubaalew/run/actions/workflows/release.yml"><img src="https://github.com/Esubaalew/run/actions/workflows/release.yml/badge.svg" alt="Release pipeline" /></a>
99
<a href="https://github.com/Esubaalew/run/releases/latest"><img src="https://img.shields.io/github/v/release/Esubaalew/run?display_name=tag&sort=semver" alt="Latest release" /></a>
1010
<a href="https://github.com/Esubaalew/run/releases"><img src="https://img.shields.io/github/downloads/Esubaalew/run/total.svg" alt="Downloads" /></a>
11+
<a href="https://crates.io/crates/run-kit"><img src="https://img.shields.io/crates/v/run-kit.svg?label=crates.io&logo=rust" alt="crates.io" /></a>
1112
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="License" /></a>
1213
</p>
1314

@@ -31,7 +32,7 @@
3132

3233
---
3334

34-
## Quickstart
35+
## Quickstart
3536

3637
```bash
3738
# Show build metadata for the current binary
@@ -50,8 +51,7 @@ run
5051
echo '{"name":"Ada"}' | run js --code "const data = JSON.parse(require('fs').readFileSync(0, 'utf8')); console.log(`hi ${data.name}`)"
5152
```
5253

53-
54-
## Installation
54+
## Installation
5555

5656
All release assets are published on the [GitHub Releases](https://github.com/Esubaalew/run/releases) page, including macOS builds for both Apple Silicon (arm64) and Intel (x86_64). Pick the method that fits your platform:
5757

@@ -73,7 +73,7 @@ cargo install run-kit
7373
brew install --formula https://github.com/Esubaalew/run/releases/latest/download/homebrew-run.rb
7474
```
7575

76-
> This formula is published as a standalone file on each release; it isn’t part of the default Homebrew taps. Installing by name (`brew install homebrew-run`) will fail—always point Homebrew to the release URL above (or download the file and run `brew install ./homebrew-run.rb`).
76+
> This formula is published as a standalone file on each release; it isn’t part of the default Homebrew taps. Installing by name (`brew install homebrew-run`) will fail—always point Homebrew to the release URL above (or download the file and run `brew install ./homebrew-run.rb`).
7777
7878
Once the latest release artifacts are published, Homebrew automatically selects the correct macOS binary for your CPU (Intel or Apple Silicon) based on this formula.
7979

@@ -134,7 +134,7 @@ The project targets Rust 1.70+. Installing from crates.io gives you the same `ru
134134

135135
</details>
136136

137-
## How it works
137+
## How it works
138138

139139
`run` shells out to real toolchains under the hood. Each `LanguageEngine` implements a small trait that knows how to:
140140

@@ -145,19 +145,17 @@ The project targets Rust 1.70+. Installing from crates.io gives you the same `ru
145145

146146
This architecture keeps the core lightweight while making it easy to add new runtimes or swap implementations.
147147

148-
## Supported languages
148+
## Supported languages
149149

150-
`run` supportes 25+ languages:
150+
`run` supports 25+ languages:
151151

152152
| Category | Languages & aliases | Toolchain expectations |
153153
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ |
154154
| **Scripting & shells** | Bash (`bash`), Python (`py`, `python`), Ruby (`rb`, `ruby`), PHP (`php`), Perl (`perl`), Lua (`lua`), R (`r`), Elixir (`ex`, `elixir`) | Matching interpreter on `PATH` |
155155
| **Web & typed scripting** | JavaScript (`js`, `node`), TypeScript (`ts`, `deno`), Dart (`dart`), Swift (`swift`), Kotlin (`kt`, `kotlin`) | `node`, `deno`, `dart`, `swift`, `kotlinc` + JRE |
156156
| **Systems & compiled** | C (`c`), C++ (`cpp`, `cxx`), Rust (`rs`, `rust`), Go (`go`), Zig (`zig`), Nim (`nim`), Haskell (`hs`, `haskell`), Crystal (`cr`, `crystal`), C# (`cs`, `csharp`), Java (`java`), Julia (`jl`, `julia`) | Respective compiler / toolchain |
157157

158-
159-
160-
## Examples
158+
## Examples
161159

162160
Real programs live under the [`examples/`](examples) tree—each language has a `hello` and a `progress` scenario. The headers document expected output so you can diff your toolchain.
163161

@@ -167,8 +165,8 @@ run examples/typescript/progress.ts
167165
run examples/python/counter.py
168166
```
169167

168+
## REPL
170169

171-
## REPL
172170
Being inside REPL we can use the ff commands
173171

174172
| Command | Purpose |
@@ -181,12 +179,7 @@ Being inside REPL we can use the ff commands
181179
| `:reset` | Clear the accumulated session state |
182180
| `:exit` / `:quit` | Leave the REPL |
183181

184-
185-
186-
187-
188-
189-
## License
182+
## License
190183

191184
Apache 2.0. See [LICENSE](LICENSE) for details.
192185

0 commit comments

Comments
 (0)