From 3c2f6f480e3008f4ffc59fe089aab1df43c0dab3 Mon Sep 17 00:00:00 2001 From: Pablo Tovar Date: Mon, 12 Jan 2026 20:45:33 +0100 Subject: [PATCH] docs: document about account access Add README examples for getUserAboutAccount and about command. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 8c85c9f..0de03a9 100644 --- a/README.md +++ b/README.md @@ -152,6 +152,22 @@ const sportsNews = await client.getNews(10, { }); ``` +Account details (About profile): + +```ts +const aboutResult = await client.getUserAboutAccount('steipete'); +if (aboutResult.success && aboutResult.aboutProfile) { + console.log(aboutResult.aboutProfile.accountBasedIn); +} +``` + +Fields: +- `accountBasedIn` +- `source` +- `createdCountryAccurate` +- `locationAccurate` +- `learnMoreUrl` + ## Commands - `bird tweet ""` — post a new tweet. @@ -175,6 +191,7 @@ const sportsNews = await client.getNews(10, { - `bird list-timeline [-n count] [--all] [--max-pages n] [--cursor string] [--json]` — get tweets from a list timeline; `--max-pages` implies `--all`. - `bird following [--user ] [-n count] [--cursor string] [--all] [--max-pages n] [--json]` — list users that you (or another user) follow; `--max-pages` requires `--all`. - `bird followers [--user ] [-n count] [--cursor string] [--all] [--max-pages n] [--json]` — list users that follow you (or another user); `--max-pages` requires `--all`. +- `bird about <@handle> [--json]` — get account origin and location information for a user. - `bird whoami` — print which Twitter account your relay belongs to. - `bird check` — verify relay configuration and account access.