Skip to content

Commit 6a3f8f4

Browse files
committed
chore(docs) - update release notes template
1 parent f9c69af commit 6a3f8f4

File tree

3 files changed

+53
-93
lines changed

3 files changed

+53
-93
lines changed

.github/workflows/release-app.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -130,14 +130,14 @@ jobs:
130130
cat > /tmp/release_body.md << 'BODY_EOF'
131131
## Installation
132132
133-
### npm (recommended)
133+
### curl (recommended)
134134
```bash
135-
npm install -g @t-req/app
135+
curl -fsSL https://t-req.io/install | bash
136136
```
137137
138-
### curl
138+
### npm
139139
```bash
140-
curl -fsSL https://t-req.io/install | bash
140+
npm install -g @t-req/app
141141
```
142142
143143
### Manual download

README.md

Lines changed: 49 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -8,128 +8,88 @@
88
[![CI](https://github.com/tensorix-labs/t-req/actions/workflows/ci.yml/badge.svg)](https://github.com/tensorix-labs/t-req/actions/workflows/ci.yml)
99
[![Discord](https://img.shields.io/badge/Discord-Join%20us-5865F2?logo=discord&logoColor=white)](https://discord.gg/sKY4M3eS)
1010

11-
HTTP request parsing, execution, and testing. Define requests in `.http` files, test them in isolation.
11+
HTTP request parsing, execution, and testing. Define requests in `.http` files, explore them in the TUI or web dashboard, see every request your scripts make.
1212

13-
**Visit the docs at [t-req.io](https://t-req.io)**
13+
**[Read the docs](https://t-req.io)** | **[Join Discord](https://discord.gg/sKY4M3eS)**
1414

15-
## Why t-req
16-
17-
- **`.http` files as source of truth** -- Standard format supported by VS Code REST Client and JetBrains HTTP Client. Version-controllable, diffable, shareable.
18-
- **Library-first** -- `@t-req/core` is an embeddable TypeScript library. Use it in scripts, tests, CI, or your own tools.
19-
- **Full dev workflow** -- CLI scaffolding, TUI for interactive exploration, web dashboard for visual debugging, all wired to the same server.
20-
- **Multi-language server** -- `treq serve` exposes a REST API so Python, Go, Ruby, or any language can execute `.http` files.
21-
- **Zero-config observability** -- Run scripts from the TUI and every HTTP request automatically appears in the dashboard. No code changes required.
22-
- **Extensible with plugins** -- Add custom resolvers, hooks, and middleware. Write plugins in TypeScript or any language via subprocess protocol.
23-
- **One command** -- `treq open` starts the server, TUI, and optionally the web dashboard.
24-
25-
## Ecosystem
26-
27-
```
28-
treq open
29-
|
30-
+--------+--------+
31-
| |
32-
treq serve treq tui
33-
(HTTP API server) (terminal UI)
34-
| |
35-
+--------+--------+
36-
|
37-
@t-req/core
38-
(parse, interpolate,
39-
execute .http files)
40-
|
41-
.http files (source of truth)
42-
43-
+----------------------------------------------------------+
44-
| @t-req/web Browser dashboard (--web flag) |
45-
| @t-req/ui Shared theme & Tailwind config |
46-
| @t-req/webdocs Documentation site |
47-
+----------------------------------------------------------+
48-
```
49-
50-
## Quick Start
51-
52-
### As a library
15+
## Install
5316

5417
```bash
55-
npm install @t-req/core
18+
curl -fsSL https://t-req.io/install | bash
5619
```
5720

58-
```typescript
59-
import { createClient } from '@t-req/core';
60-
import { createNodeIO } from '@t-req/core/runtime';
21+
<p align="center">
22+
<img src="./docs/assets/web.png" alt="t-req web dashboard">
23+
</p>
6124

62-
const client = createClient({
63-
io: createNodeIO(),
64-
variables: { email: 'user@example.com', password: 'secret' },
65-
});
25+
## What You Can Do
6626

67-
const response = await client.run('./auth/login.http');
68-
const { token } = await response.json();
69-
```
27+
- **`treq open`** - One command starts the server + TUI
28+
- **`treq open --web`** - Add a browser-based dashboard
29+
- **`treq init`** - Scaffold complete projects instantly
30+
- **Observer Mode** - See HTTP requests from scripts in real-time, no code changes
31+
- **Language-agnostic** - Python, Go, Ruby via `treq serve`
32+
- **Standard `.http` files** - VS Code REST Client / JetBrains compatible
7033

71-
### As a CLI tool
34+
## Quick Start
35+
36+
### Primary workflow
7237

7338
```bash
74-
# Install via curl
39+
# Install
7540
curl -fsSL https://t-req.io/install | bash
7641

77-
# Or via npm
78-
npm install -g @t-req/app
79-
```
42+
# Create a project
43+
treq init my-api && cd my-api
8044

81-
```bash
82-
# Scaffold a project
83-
treq init my-api
84-
85-
# Open the TUI + server (the primary workflow)
86-
cd my-api && treq open
45+
# Open TUI
46+
treq open
8747

88-
# Or open with the web dashboard too
48+
# Or with web dashboard
8949
treq open --web
9050
```
9151

92-
### As a multi-language server
52+
### Multi-language server
53+
54+
For Python, Go, Ruby, or any language:
9355

9456
```bash
9557
treq serve --port 4096
9658

97-
# From any language -- just POST to the server
59+
# POST from any language
9860
curl -X POST http://localhost:4096/execute \
9961
-H "Content-Type: application/json" \
10062
-d '{"content": "GET https://httpbin.org/get"}'
10163
```
10264

103-
## Packages
65+
### TypeScript library
10466

105-
| Package | Description |
106-
|---------|-------------|
107-
| [@t-req/core](./packages/core) | Core HTTP request parsing and execution library |
108-
| [@t-req/app](./packages/app) | CLI for scaffolding, executing, and serving t-req projects |
109-
| [@t-req/web](./packages/web) | Browser dashboard for the t-req server |
110-
| [@t-req/ui](./packages/ui) | Shared UI components and Tailwind CSS configuration |
111-
| [@t-req/webdocs](./packages/webdocs) | Documentation site |
67+
For tests, scripts, or building your own tools:
11268

113-
## Documentation
69+
```bash
70+
npm install @t-req/core
71+
```
11472

115-
Visit [t-req.io](https://t-req.io) for full documentation, guides, and API reference.
73+
```typescript
74+
import { createClient } from '@t-req/core';
75+
import { createNodeIO } from '@t-req/core/runtime';
11676

117-
## Monorepo Structure
77+
const client = createClient({
78+
io: createNodeIO(),
79+
variables: { email: 'user@example.com', password: 'secret' },
80+
});
11881

82+
const response = await client.run('./auth/login.http');
83+
const { token } = await response.json();
11984
```
120-
t-req/
121-
├── examples/
122-
│ ├── plugins/ # Plugin examples
123-
│ └── ...
124-
├── packages/
125-
│ ├── core/ # @t-req/core - HTTP parsing & execution
126-
│ ├── app/ # @t-req/app - CLI, TUI, and server
127-
│ ├── web/ # @t-req/web - Browser dashboard
128-
│ ├── webdocs/ # @t-req/webdocs - Documentation site
129-
│ └── ui/ # @t-req/ui - UI components & theming
130-
├── .changeset/ # Changesets for versioning
131-
└── ...
132-
```
85+
86+
## Packages
87+
88+
| Package | Description |
89+
|---------|-------------|
90+
| [@t-req/core](./packages/core) | HTTP parsing and execution library |
91+
| [@t-req/app](./packages/app) | CLI, TUI, and server |
92+
| [@t-req/web](./packages/web) | Browser dashboard |
13393

13494
## Contributing
13595

docs/assets/web.png

108 KB
Loading

0 commit comments

Comments
 (0)