Skip to content

Commit cd3aa8e

Browse files
committed
docs: Update documentation to reflect current state
Add clear alpha status warnings, and other relevant sections of documentation
1 parent 685ab0e commit cd3aa8e

File tree

2 files changed

+24
-26
lines changed

2 files changed

+24
-26
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,12 @@
77

88
`req` is a lightweight, terminal-based API client built for the
99
[Boot.dev Hackathon 2025](https://blog.boot.dev/news/hackathon-2025/#12-honorable-mentions-no-prizes-sorry), where it received an **honorable mention**.
10-
It features a fast and minimal text user interface and lets you create, send,
11-
and inspect HTTP requests interactively from the command line. It is ideal for
12-
testing APIs without leaving your terminal.
10+
**Current Status**: Early development (alpha). Core HTTP execution features are still in progress.
11+
12+
The goal is to provide a fast, minimal terminal interface for creating, sending,
13+
and inspecting HTTP requests interactively from the command line.
14+
15+
> The app works completely offline with no external dependencies required.
1316
1417
Read more about `req` over here -
1518
[Announcement Blog](https://maniac-en.github.io/req/)

docs/index.html

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,9 @@
1313
<article>
1414
<div><img src="images/banner.png" alt="Req Banner" style="width: 100%; max-width: 800px; margin-bottom: 20px;">
1515
<h1>Req - Test APIs with Terminal Velocity</h1>
16-
<p>A terminal-based API client built for the <a href="https://blog.boot.dev/news/hackathon-2025/">Boot.dev
17-
Hackathon 2025</a>.</p>
18-
<h2>Features</h2>
19-
<ul>
20-
<li>Terminal user interface with beautiful TUI</li>
21-
<li>Request collections and organization</li>
22-
<li>Demo data generation with realistic APIs</li>
23-
<li>Request builder with tabs for body, headers, query params</li>
24-
<li>Production-ready logging system</li>
25-
</ul>
16+
<p>A terminal-based API client built for the <a href="https://blog.boot.dev/news/hackathon-2025/#12-honorable-mentions-no-prizes-sorry">Boot.dev
17+
Hackathon 2025</a>, where it received an <b>honorable mention</b>.</p>
18+
<p><b>Current Status:</b> Early development (alpha). Core HTTP execution features are still in progress.</p>
2619
<h2>Tech Stack</h2>
2720
<p>The project uses:</p>
2821
<ol>
@@ -45,27 +38,29 @@ <h2>Installation</h2>
4538
</pre><video src="/req/demo.mp4" controls style="width: 100%; max-width: 800px; margin: 20px 0;"></video>
4639
<h2>What's Implemented</h2>
4740
<ul>
48-
<li>Collections CRUD operations (create, edit, delete, navigate)</li>
49-
<li>Request builder interface with tabbed editing</li>
50-
<li>Endpoint browsing with sidebar navigation</li>
51-
<li>Demo data generation (JSONPlaceholder, ReqRes, HTTPBin APIs)</li>
52-
<li>Beautiful warm color scheme with vim-like navigation</li>
53-
<li>Pagination and real-time search filtering</li>
41+
<li>TUI interface with collections and endpoints navigation</li>
42+
<li>SQLite-based storage with migrations</li>
43+
<li>Basic request builder interface</li>
5444
</ul>
5545
<h2>Coming Soon</h2>
5646
<ul>
5747
<li>HTTP request execution (core feature)</li>
5848
<li>Response viewer with syntax highlighting</li>
59-
<li>Endpoint management (add/edit endpoints)</li>
49+
<li>Complete endpoint management</li>
6050
<li>Environment variables support</li>
61-
<li>Export/import functionality</li>
6251
</ul>
6352
<h2>Try It Out</h2>
64-
<p><b>GitHub</b>: https://github.com/maniac-en/req<br>
65-
<b>Installation</b>: <code>go install github.com/maniac-en/req@latest</code> or <code>go install github.com/maniac-en/req@v0.1.0</code><br>
66-
<b>Usage</b>: Just run <code>req</code> in your terminal!
67-
</p>
68-
<p>The app works completely offline with no external dependencies required.</p>
53+
54+
<p><strong>GitHub Repository:</strong><br>
55+
<a href="https://github.com/maniac-en/req">https://github.com/maniac-en/req</a></p>
56+
57+
<p><strong>Installation:</strong></p>
58+
<pre>go install github.com/maniac-en/req@latest</pre>
59+
60+
<p><strong>Usage:</strong></p>
61+
<pre>req</pre>
62+
63+
<p><em>Note: The app works completely offline with no external dependencies required.</em></p>
6964
<p>---</p>
7065
<p>This blog is built with ❤️ using <a href="https://github.com/maniac-en/pyssg">pyssg</a> - A guided
7166
learning project at <a href="https://www.boot.dev/courses/build-static-site-generator">boot.dev</a></p>

0 commit comments

Comments
 (0)