Skip to content

Commit 685ab0e

Browse files
committed
docs: Fix links and add honorable mention
- Fix broken LICENSE link in README.md - Add Boot.dev Hackathon 2025 honorable mention with proper link - Update RELEASE.md to accurately reflect release notes source - Remove outdated hackathon timeline references
1 parent 4fd9c70 commit 685ab0e

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
## About
77

88
`req` is a lightweight, terminal-based API client built for the
9-
[Boot.dev Hackathon 2025](https://github.com/maniac-en/req?tab=License-1-ov-file).
9+
[Boot.dev Hackathon 2025](https://blog.boot.dev/news/hackathon-2025/#12-honorable-mentions-no-prizes-sorry), where it received an **honorable mention**.
1010
It features a fast and minimal text user interface and lets you create, send,
1111
and inspect HTTP requests interactively from the command line. It is ideal for
1212
testing APIs without leaving your terminal.
@@ -52,7 +52,7 @@ req
5252
## License
5353

5454
This project is licensed under the
55-
[MIT License](https://github.com/maniac-en/req?tab=License-1-ov-file).
55+
[MIT License](https://github.com/maniac-en/req/blob/main/LICENSE).
5656

5757
```
5858
1. Mudassir Bilal (mailto:mughalmudassir966@gmail.com)

RELEASE.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,10 @@ The release workflow automatically builds:
9999
- `req-v0.1.0-alpha.2-windows-amd64.exe`
100100

101101
### Release Notes
102-
Automatically generated with:
102+
Generated from template in `.github/workflows/release.yml` including:
103103
- Project description
104104
- Installation instructions (`go install` and binary downloads)
105+
- Breaking change warnings (database cleanup instructions)
105106
- Usage information
106107
- Development stage disclaimer
107108
- Link to full changelog
@@ -134,7 +135,7 @@ No fixed schedule. Releases are created when:
134135
- Important bug fixes are ready
135136
- Milestone requirements are met
136137

137-
For hackathon timeline, aim for `v0.1.0-alpha.x` releases as features are completed.
138+
Release `v0.1.0-alpha.x` versions as features are completed and tested.
138139

139140
## Rollback Process
140141

0 commit comments

Comments
 (0)