Skip to content

Commit 32f593e

Browse files
Update README with release instructions
1 parent aa3e357 commit 32f593e

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ fm draft send M9876543210
3737

3838
## Installation
3939

40-
### Homebrew
40+
### Homebrew (recommended)
4141

4242
```bash
43-
brew install marckohlbrugge/tap/fm --HEAD
43+
brew install marckohlbrugge/tap/fm
4444
```
4545

4646
### From Source
@@ -58,7 +58,7 @@ Then move `fm` to somewhere in your PATH, or add the directory to your PATH.
5858
### Homebrew
5959

6060
```bash
61-
brew upgrade marckohlbrugge/tap/fm
61+
brew update && brew upgrade fm
6262
```
6363

6464
### From Source
@@ -237,6 +237,26 @@ make build # Build binary
237237
make test # Run tests
238238
```
239239

240+
### Releasing
241+
242+
To release a new version:
243+
244+
```bash
245+
git tag v1.x.x
246+
git push origin v1.x.x
247+
```
248+
249+
This triggers GitHub Actions to build binaries for macOS (Intel/ARM) and Linux (amd64/arm64) and create a GitHub release.
250+
251+
Then update the Homebrew formula manually:
252+
253+
```bash
254+
# Get checksums from the release
255+
gh release download v1.x.x --pattern 'checksums.txt' --output -
256+
257+
# Update Formula/fm.rb in marckohlbrugge/homebrew-tap with new version and checksums
258+
```
259+
240260
## Contributing
241261

242262
I'm not accepting pull requests at this time—reviewing external code for security in a tool that handles email requires more time than I can commit to. Feel free to [open an issue](https://github.com/marckohlbrugge/fastmail-cli/issues) for bug reports or feature requests.

0 commit comments

Comments
 (0)