From 685ab0eb4f71a86e2559c48eb0303dc602b503b8 Mon Sep 17 00:00:00 2001 From: Shivam Mehta Date: Wed, 30 Jul 2025 01:15:06 +0530 Subject: [PATCH 1/2] 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 --- README.md | 4 ++-- RELEASE.md | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7329acc..a707b26 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ## About `req` is a lightweight, terminal-based API client built for the -[Boot.dev Hackathon 2025](https://github.com/maniac-en/req?tab=License-1-ov-file). +[Boot.dev Hackathon 2025](https://blog.boot.dev/news/hackathon-2025/#12-honorable-mentions-no-prizes-sorry), where it received an **honorable mention**. It features a fast and minimal text user interface and lets you create, send, and inspect HTTP requests interactively from the command line. It is ideal for testing APIs without leaving your terminal. @@ -52,7 +52,7 @@ req ## License This project is licensed under the -[MIT License](https://github.com/maniac-en/req?tab=License-1-ov-file). +[MIT License](https://github.com/maniac-en/req/blob/main/LICENSE). ``` 1. Mudassir Bilal (mailto:mughalmudassir966@gmail.com) diff --git a/RELEASE.md b/RELEASE.md index 463d033..1a74d5c 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -99,9 +99,10 @@ The release workflow automatically builds: - `req-v0.1.0-alpha.2-windows-amd64.exe` ### Release Notes -Automatically generated with: +Generated from template in `.github/workflows/release.yml` including: - Project description - Installation instructions (`go install` and binary downloads) +- Breaking change warnings (database cleanup instructions) - Usage information - Development stage disclaimer - Link to full changelog @@ -134,7 +135,7 @@ No fixed schedule. Releases are created when: - Important bug fixes are ready - Milestone requirements are met -For hackathon timeline, aim for `v0.1.0-alpha.x` releases as features are completed. +Release `v0.1.0-alpha.x` versions as features are completed and tested. ## Rollback Process From cd3aa8e2f267301e4290f72cdb7583a755315add Mon Sep 17 00:00:00 2001 From: Shivam Mehta Date: Wed, 30 Jul 2025 01:20:25 +0530 Subject: [PATCH 2/2] docs: Update documentation to reflect current state Add clear alpha status warnings, and other relevant sections of documentation --- README.md | 9 ++++++--- docs/index.html | 41 ++++++++++++++++++----------------------- 2 files changed, 24 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index a707b26..66e76c6 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,12 @@ `req` is a lightweight, terminal-based API client built for the [Boot.dev Hackathon 2025](https://blog.boot.dev/news/hackathon-2025/#12-honorable-mentions-no-prizes-sorry), where it received an **honorable mention**. -It features a fast and minimal text user interface and lets you create, send, -and inspect HTTP requests interactively from the command line. It is ideal for -testing APIs without leaving your terminal. +**Current Status**: Early development (alpha). Core HTTP execution features are still in progress. + +The goal is to provide a fast, minimal terminal interface for creating, sending, +and inspecting HTTP requests interactively from the command line. + +> The app works completely offline with no external dependencies required. Read more about `req` over here - [Announcement Blog](https://maniac-en.github.io/req/) diff --git a/docs/index.html b/docs/index.html index 9c439a2..2fcdcf6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -13,16 +13,9 @@
Req Banner

Req - Test APIs with Terminal Velocity

-

A terminal-based API client built for the Boot.dev - Hackathon 2025.

-

Features

-
    -
  • Terminal user interface with beautiful TUI
    • -
  • Request collections and organization
    • -
  • Demo data generation with realistic APIs
    • -
  • Request builder with tabs for body, headers, query params
    • -
  • Production-ready logging system
    • -
+

A terminal-based API client built for the Boot.dev + Hackathon 2025, where it received an honorable mention.

+

Current Status: Early development (alpha). Core HTTP execution features are still in progress.

Tech Stack

The project uses:

    @@ -45,27 +38,29 @@

    Installation

    What's Implemented

      -
    • Collections CRUD operations (create, edit, delete, navigate)
      • -
    • Request builder interface with tabbed editing
      • -
    • Endpoint browsing with sidebar navigation
      • -
    • Demo data generation (JSONPlaceholder, ReqRes, HTTPBin APIs)
      • -
    • Beautiful warm color scheme with vim-like navigation
      • -
    • Pagination and real-time search filtering
      • +
    • TUI interface with collections and endpoints navigation
      • +
    • SQLite-based storage with migrations
      • +
    • Basic request builder interface

    Coming Soon

    • HTTP request execution (core feature)
    • Response viewer with syntax highlighting
      • -
    • Endpoint management (add/edit endpoints)
      • +
    • Complete endpoint management
    • Environment variables support
      • -
    • Export/import functionality

    Try It Out

    -

    GitHub: https://github.com/maniac-en/req
    - Installation: go install github.com/maniac-en/req@latest or go install github.com/maniac-en/req@v0.1.0
    - Usage: Just run req in your terminal! -

    -

    The app works completely offline with no external dependencies required.

    + +

    GitHub Repository:
    + https://github.com/maniac-en/req

    + +

    Installation:

    + 
    go install github.com/maniac-en/req@latest
    + +

    Usage:

    + 
    req
    + +

    Note: The app works completely offline with no external dependencies required.

    ---

    This blog is built with ❤️ using pyssg - A guided learning project at boot.dev