Skip to content

Commit e81266e

Browse files
committed
Prepare release 0.3.0
1 parent 2969d8f commit e81266e

7 files changed

Lines changed: 27 additions & 30 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ capture messy thought -> structure memory card -> store locally -> retrieve with
99
```
1010

1111
Full documentation lives at **https://shusingh.github.io/waymark/**.
12-
The planned PyPI package name is **`waymark-memory`**; the installed command
13-
remains **`waymark`**.
12+
The PyPI package name is **`waymark-memory`**; the installed command remains
13+
**`waymark`**.
1414
The complete CLI reference is generated from the Typer app, so use the docs site
1515
instead of hand-maintained command lists.
1616

@@ -26,7 +26,7 @@ instead of hand-maintained command lists.
2626

2727
## Install
2828

29-
After PyPI publishing is enabled:
29+
Recommended install:
3030

3131
```bash
3232
pipx install waymark-memory
@@ -36,7 +36,7 @@ waymark --version
3636
Current GitHub Release:
3737

3838
```bash
39-
python -m pip install https://github.com/shusingh/waymark/releases/download/v0.2.0/waymark-0.2.0-py3-none-any.whl
39+
python -m pip install https://github.com/shusingh/waymark/releases/download/v0.3.0/waymark_memory-0.3.0-py3-none-any.whl
4040
waymark --version
4141
```
4242

docs/contributing.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,22 +86,22 @@ development version to the exact public version, then commit that release prep.
8686
Push a matching version tag to start the release workflow:
8787

8888
```bash
89-
git commit -am "Prepare release 0.2.0"
90-
git tag v0.2.0
89+
git commit -am "Prepare release 0.3.0"
90+
git tag v0.3.0
9191
git push origin main
92-
git push origin v0.2.0
92+
git push origin v0.3.0
9393
```
9494

95-
The tag must match the package version exactly. For example, `v0.2.0` requires:
95+
The tag must match the package version exactly. For example, `v0.3.0` requires:
9696

9797
```toml
98-
version = "0.2.0"
98+
version = "0.3.0"
9999
```
100100

101101
and:
102102

103103
```python
104-
__version__ = "0.2.0"
104+
__version__ = "0.3.0"
105105
```
106106

107107
The release workflow verifies the code, confirms the tag/version match, builds

docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ it again, ask a grounded question, and reflect.
2929
python3 -m pipx install waymark-memory
3030
```
3131

32-
Until PyPI is live, use the GitHub Release wheel from
33-
[Installation & Updates](guides/installation.md).
32+
The [Installation & Updates](guides/installation.md) guide also includes direct
33+
GitHub Release wheel commands.
3434

3535
## 2. Pick where your data lives
3636

docs/guides/installation.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Installation & Updates
22

33
Waymark is a Python CLI/TUI application. The installed command is `waymark`.
4-
The planned PyPI distribution name is `waymark-memory` because `waymark` is
5-
already taken on PyPI by another project.
4+
The PyPI distribution name is `waymark-memory` because `waymark` is already
5+
taken on PyPI by another project.
66

77
## Recommended Install
88

@@ -42,25 +42,21 @@ while still exposing the `waymark` command.
4242
If `waymark` is not found after installation, open a new terminal so the updated
4343
PATH from `pipx ensurepath` is loaded.
4444

45-
!!! warning "PyPI is not live yet"
46-
Until the PyPI trusted-publisher setup is completed, use the GitHub Release
47-
wheel below.
48-
4945
## Current GitHub Release
5046

5147
Install the current public release directly from GitHub:
5248

5349
=== "Windows PowerShell"
5450

5551
```powershell
56-
py -m pip install https://github.com/shusingh/waymark/releases/download/v0.2.0/waymark-0.2.0-py3-none-any.whl
52+
py -m pip install https://github.com/shusingh/waymark/releases/download/v0.3.0/waymark_memory-0.3.0-py3-none-any.whl
5753
waymark --version
5854
```
5955

6056
=== "macOS / Linux"
6157

6258
```bash
63-
python3 -m pip install https://github.com/shusingh/waymark/releases/download/v0.2.0/waymark-0.2.0-py3-none-any.whl
59+
python3 -m pip install https://github.com/shusingh/waymark/releases/download/v0.3.0/waymark_memory-0.3.0-py3-none-any.whl
6460
waymark --version
6561
```
6662

@@ -141,7 +137,7 @@ For a PyPI install:
141137
For a GitHub wheel install, install the newer release wheel URL:
142138

143139
```bash
144-
python -m pip install --upgrade https://github.com/shusingh/waymark/releases/download/v0.2.0/waymark-0.2.0-py3-none-any.whl
140+
python -m pip install --upgrade https://github.com/shusingh/waymark/releases/download/v0.3.0/waymark_memory-0.3.0-py3-none-any.whl
145141
```
146142

147143
For a source checkout:
@@ -154,7 +150,8 @@ python -m pip install -e ".[dev,docs,pdf]"
154150
## Publishing to PyPI
155151

156152
Waymark uses PyPI Trusted Publishing rather than a long-lived API token. The
157-
project must first be configured in PyPI as a pending trusted publisher.
153+
project is published from the tag workflow after the trusted publisher is
154+
configured in PyPI.
158155

159156
Use these values:
160157

docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ capture -> timeline -> ask with sources -> reflect -> review decisions
1313
```
1414

1515
!!! note "Package name"
16-
The PyPI distribution is planned as `waymark-memory` because `waymark` is
17-
already used by another package. The installed command remains `waymark`.
16+
The PyPI distribution is `waymark-memory` because `waymark` is already used
17+
by another package. The installed command remains `waymark`.
1818

1919
## Install
2020

21-
After PyPI publishing is enabled, install Waymark with `pipx`:
21+
Install Waymark with `pipx`:
2222

2323
=== "Windows PowerShell"
2424

@@ -47,10 +47,10 @@ After PyPI publishing is enabled, install Waymark with `pipx`:
4747
waymark --version
4848
```
4949

50-
Until PyPI publishing is enabled, install the latest GitHub Release wheel:
50+
You can also install the latest GitHub Release wheel directly:
5151

5252
```bash
53-
python -m pip install https://github.com/shusingh/waymark/releases/download/v0.2.0/waymark-0.2.0-py3-none-any.whl
53+
python -m pip install https://github.com/shusingh/waymark/releases/download/v0.3.0/waymark_memory-0.3.0-py3-none-any.whl
5454
```
5555

5656
## First minute

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[build-system]
2-
requires = ["hatchling"]
2+
requires = ["hatchling<1.30"]
33
build-backend = "hatchling.build"
44

55
[project]
66
name = "waymark-memory"
7-
version = "0.3.0.dev0"
7+
version = "0.3.0"
88
description = "A local-first terminal companion for personal memory, reflection, and decisions."
99
readme = "README.md"
1010
requires-python = ">=3.11"

src/waymark/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
"""Waymark package."""
22

3-
__version__ = "0.3.0.dev0"
3+
__version__ = "0.3.0"

0 commit comments

Comments
 (0)