Skip to content

Commit 12d724b

Browse files
committed
docs: add MIT license, Homebrew install instructions, and GoReleaser dry-run docs
1 parent cb60725 commit 12d724b

3 files changed

Lines changed: 70 additions & 3 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 topfunky
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Makefile

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: build install clean test list
1+
.PHONY: build install clean test list release-dry-run
22

33
# Display available tasks
44
list:
@@ -20,3 +20,8 @@ clean:
2020
test:
2121
@echo "Running tests..."
2222
go test ./...
23+
24+
# Test release process with GoReleaser (dry-run)
25+
release-dry-run:
26+
@echo "Running GoReleaser dry-run..."
27+
goreleaser release --snapshot --skip-publish --clean

README.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,24 @@ A simple command-line application to run a [Pomodoro](https://www.pomodorotechni
1010

1111
## Installation
1212

13+
### Homebrew (macOS/Linux)
14+
15+
Install from the topfunky tap:
16+
17+
```bash
18+
brew install topfunky/tap/tiny-timer
19+
```
20+
21+
### From Source
22+
1323
1. Clone the repository:
1424

1525
```bash
1626
git clone https://github.com/topfunky/tiny-timer.git
1727
cd tiny-timer
1828
```
1929

20-
1. Build and install the application to your `GOPATH/bin`:
30+
2. Build and install the application to your `GOPATH/bin`:
2131

2232
```bash
2333
make install
@@ -37,6 +47,35 @@ Or specify a custom duration in minutes:
3747
tiny-timer 5
3848
```
3949

50+
## Development
51+
52+
### Testing Releases with GoReleaser
53+
54+
To test the release process without creating an actual release, use the make target:
55+
56+
```bash
57+
make release-dry-run
58+
```
59+
60+
Or run GoReleaser directly:
61+
62+
```bash
63+
goreleaser release --snapshot --skip-publish --clean
64+
```
65+
66+
This will:
67+
- Build binaries for all configured platforms (Linux, macOS, Windows)
68+
- Create archives and checksums
69+
- Generate the Homebrew formula
70+
- Skip publishing to GitHub
71+
- Clean up previous build artifacts
72+
73+
For a full dry-run that also validates publishing (without actually publishing):
74+
75+
```bash
76+
goreleaser release --snapshot --skip-publish
77+
```
78+
4079
## Dependencies
4180

4281
This project uses the following Go packages:
@@ -47,6 +86,8 @@ This project uses the following Go packages:
4786

4887
## License
4988

50-
This project is currently private and has no license. It includes sample code from the Bubbles project.
89+
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
90+
91+
It includes sample code from the Bubbles project.
5192

5293
[Pomodoro](https://www.pomodorotechnique.com) is a trademark of Francesco Cirillo. The Pomodoro Technique is a time management method developed by Cirillo in the late 1980s.

0 commit comments

Comments
 (0)