Skip to content

Commit 1d55310

Browse files
KooshaPariKooshaPariCursor Grok 4.5
authored
docs(release): prefer crates.io install after v0.1.0 publish (#147)
Co-authored-by: KooshaPari <koosha@example.com> Co-authored-by: Cursor Grok 4.5 <noreply@cursor.com>
1 parent a97e0c8 commit 1d55310

2 files changed

Lines changed: 26 additions & 15 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
44

55
## [Unreleased]
66

7+
### Changed
8+
9+
- README Install prefers crates.io after `v0.1.0` publish.
10+
711
### Added
812

913
### Changed

README.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,14 @@
2424

2525
| Field | Value |
2626
|---|---|
27-
| Crate version | `0.1.0` in workspace `Cargo.toml`**no crates.io publish yet** |
28-
| crates.io | **Not published**do not use `cargo install phenotype-journey` / `cargo add phenotype-journey-core` |
27+
| Crate version | `0.1.0` — tagged [`v0.1.0`](https://github.com/KooshaPari/phenotype-journeys/releases/tag/v0.1.0) |
28+
| crates.io | **Published**`phenotype-journey-core`, `phenotype-journeys-observability`, `phenotype-journey` |
2929
| npm | **Not on public npmjs.com**; GitHub Packages publish is documented but packages may be absent — prefer path/git |
30-
| Install path | from source — see [Install](#install) |
31-
| Focus | T0 honesty (path/git) → T1 tag `v0.1.0` → T2 crates.io (see [cutting-a-release](docs/guides/cutting-a-release.md)) |
30+
| Install path | crates.io preferred for Rust — see [Install](#install) |
31+
| Focus | Post-0.1.0 hardening; npm registry publish still open |
3232

33-
> Honest gap: local `cargo test --locked` is the verification gate. End-user
34-
> install is path/git only until a tagged release **and** crates.io publish
35-
> land ([cutting-a-release](docs/guides/cutting-a-release.md)).
33+
> First Rust release complete: git tag `v0.1.0`, GitHub Release, and crates.io
34+
> publish. Next cut: [cutting-a-release](docs/guides/cutting-a-release.md).
3635
3736
# phenotype-journeys
3837

@@ -46,26 +45,34 @@ manifest, and verify it with a Claude-describe + Claude-judge loop.
4645

4746
## Install
4847

49-
**Rust crates are not on crates.io yet.** Prefer a clone (workspace path deps):
48+
Preferred (crates.io):
49+
50+
```bash
51+
cargo install phenotype-journey --locked
52+
```
53+
54+
Library consumers:
55+
56+
```toml
57+
phenotype-journey-core = "0.1"
58+
# optional:
59+
# phenotype-journeys-observability = "0.1"
60+
```
61+
62+
From a clone (dev / unreleased `main`):
5063

5164
```bash
5265
git clone https://github.com/KooshaPari/phenotype-journeys
5366
cd phenotype-journeys
5467
cargo build --locked
5568
cargo test --locked
56-
57-
# CLI binary from the workspace
5869
cargo install --path bin/phenotype-journey --locked
5970
```
6071

61-
Or install / depend without cloning first:
72+
Or from Git without cloning first:
6273

6374
```bash
64-
# CLI
6575
cargo install --git https://github.com/KooshaPari/phenotype-journeys --locked phenotype-journey
66-
67-
# Library (Cargo.toml)
68-
# phenotype-journey-core = { git = "https://github.com/KooshaPari/phenotype-journeys" }
6976
```
7077

7178
Requires Rust stable matching `rust-toolchain.toml` (workspace MSRV intent: 1.75+).

0 commit comments

Comments
 (0)