Skip to content

Commit f976bfc

Browse files
committed
Docs: align with bun/biome and public-ready release notes
1 parent 5c96faf commit f976bfc

3 files changed

Lines changed: 21 additions & 9 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
## Unreleased
44

5-
- TBD
5+
- Tooling aligned with Bun + Biome (granola-cli style)
6+
- `promote-stubs` uses explicit plan/apply workflow
67

78
## 0.1.0
89

CONTRIBUTING.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,14 @@ Thanks for helping improve `vault-cli`.
1111
## Development
1212

1313
```bash
14-
npm i
15-
npm run build
16-
npm test
14+
bun install
15+
bun run format
16+
bun run lint
17+
bun run typecheck
18+
bun test
1719
```
1820

1921
## Releasing (later)
2022

2123
This repo is currently marked `private` in `package.json` to prevent accidental publishing.
22-
When ready, remove `private: true`, bump version, update changelog, and publish.
24+
When ready, remove `"private": true`, bump version, update changelog, and publish.

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,25 @@ Generic, scriptable maintenance commands for an Obsidian vault.
1010

1111
## Install
1212

13-
Local dev:
13+
### Local dev
1414

1515
```bash
16-
npm i
17-
npm run build
16+
bun install
17+
bun run build
1818
npm link
1919
vault --help
2020
```
2121

22-
Publishing to npm is intentionally blocked for now (`"private": true` in `package.json`).
22+
### Publishing (when ready)
23+
24+
Publishing is intentionally blocked right now (`"private": true` in `package.json`).
25+
26+
When you’re ready to go public:
27+
28+
- Remove `"private": true`
29+
- Tag a release (SemVer)
30+
- `bun run build`
31+
- `npm publish`
2332

2433
## Config
2534

0 commit comments

Comments
 (0)