Skip to content

Commit 42941d1

Browse files
ernadoclaude
andcommitted
docs(readme): drop "active reconstruction" status
The library is no longer being rebuilt from the old codegen-first design; it is a functional hand-written library with a broad typed Bot API surface. Update the status callout and package-layout wording accordingly. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 3a33ae0 commit 42941d1

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,14 @@ sidesteps the Bot API server's rate limits, removes the `getUpdates`/webhook
99
round trip, and keeps the raw `gotd/td` client one method call away
1010
(`Bot.Raw()`) for anything not yet covered.
1111

12-
> **Status: under active reconstruction.** The repo is being rebuilt from a
13-
> codegen-first OpenAPI/ogen project into a hand-written library. The `Bot`
14-
> client skeleton compiles and connects today; the typed Bot API surface
15-
> (methods, types, handler framework) is being filled in. See
16-
> [`docs/roadmap.md`](./docs/roadmap.md) for what's done and what's next.
12+
> **Status: experimental.** The library is hand-written and functional: it
13+
> connects and authorizes as a bot, serves updates over a persistent connection,
14+
> and exposes a broad typed Bot API surface — sending and editing, media,
15+
> keyboards, inline queries, payments and stars, gifts, stories, business
16+
> accounts, chat management, and the handler framework. A few areas remain
17+
> unimplemented over MTProto (see the [**guide**](./docs/guide.md)); the raw
18+
> `*tg.Client` (`Bot.Raw()`) covers anything not yet typed. The API may still
19+
> change before a stable release.
1720
1821
## Why MTProto instead of HTTP
1922

@@ -88,7 +91,7 @@ they reconnect without re-authorizing.
8891
## Package layout
8992

9093
- `botapi` (root) — the public library: the `Bot` client, options, and the
91-
hand-written Bot API surface as it lands.
94+
hand-written Bot API surface (types, methods, updates, handlers).
9295
- `pool` — runs and multiplexes many bots by token over one process.
9396
- `storage` — bbolt-backed session/peer/update-state storage.
9497
- `internal/botdoc` — fetches and extracts the published Bot API docs; kept as a

0 commit comments

Comments
 (0)