aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMaria Lisina <sekoohaka.sarisan@gmail.com>2026-02-08 04:44:06 +0300
committerMaria Lisina <sekoohaka.sarisan@gmail.com>2026-02-08 04:44:06 +0300
commit76173f433c911e7cda0db25d5b6af4c47e8b591d (patch)
tree8dbf707e00d9994cc45f7a50492060d809d8b31d /README.md
parent383284bfcbb376b4f05ad3e8b6517c89bd85239d (diff)
files/help: Update general
Signed-off-by: Maria Lisina <sekoohaka.sarisan@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md106
1 files changed, 8 insertions, 98 deletions
diff --git a/README.md b/README.md
index 2acb94e..65d76e5 100644
--- a/README.md
+++ b/README.md
@@ -2,26 +2,6 @@
Telegram Image Board Bot written in Z Shell (zsh)
-## Features
-
-* Authorization
-* Inline pools search
-* Inline posts search
-* Inline tags search
-* Inline paging
-* Inline autopaging
-* Inline resuming
-* Inline quick buttons
-* Original file download
-* Post information view
-* Post tags view
-* Post URL detection
-* MD5 hash lookup
-* SauceNAO reverse image search
-* Inline shortcuts
-* Inline shortcuts saving
-* Inline shortcuts search
-
## Requirements
### Commands
@@ -87,85 +67,15 @@ Cache modes:
advanced Extract posts cache from inline results
```
-## Usage
-
-### Fields description
-
-* `[command]` - Inline command
-* `[b]` - Image Board
-* `[page]` - Search page number
-* `[options]` - Search options
-* `[name]` - Search pool or tag name
-* `[tags]` - Search tags
-* `[query]` - Search query
-* `[id]` - Post ID
-* `[md5]` - MD5 hash
-* `[login]` - Image Board login or username
-* `[key]` - Image Board API key or password
-* `[snkey]` - SauceNAO API key
-
-### Inline search
-
-* `pools [b] [page] [options] [name]` - Pools search
-* `posts [b] [page] [options] [tags]` - Posts search
-* `tags [b] [page] [options] [name]` - Tags search
-* `shorts [page] [options] [query]` - Shortcuts search
-
-### Search options
-
-* `a` - Enable autopaging (lpts)
-* `m` - Show more metadata (p)
-* `p` - Show gif/video as preview only (p)
-* `q` - Add quick buttons (lpts)
-* `r` - Reverse search order (s)
-* `w` - Match full words only (s)
-
-### Inline commands
-
-* `help` - Send help message
-* `original [b] [id/md5]` - Get original file of post
-* `post [b] [id/md5]` - Get information of post
-* `short [query]` - Create inline shortcut
-* `donate` - Send donation details
-
-### Commands
+## Supported Image Boards
-* `/help` - Send help message
-* `/authorize [b] [login] [key]` - Authorize to Image Board
-* `/original [b] [id/md5]` - Get original file of post
-* `/post [b] [id/md5]` - Get information of post
-* `/hash [md5]` - Get posts IDs by hash lookup
-* `/source [snkey]` - Reverse search image
-* `/short [query]` - Create inline shortcut
-* `/shorts` - Manage saved shortcuts
-* `/ping` - Measure bot latency
-* `/donate` - Send donation details
-* `/export` - Export all user data
-* `/stop` - Remove all user data
-
-### Inline aliases
-
-* `l` - `pools`
-* `p` - `posts`
-* `t` - `tags`
-* `s` - `shorts`
-
-### Inline examples
-
-* `p d 1 -a rating:g`
-* `t d *genshin*`
-* `original d 4507929`
-* `short p d -mq ringouulu`
-
-### Supported Image Boards
-
-* `a` - [Safebooru](https://safebooru.donmai.us/)
-* `d` - [Danbooru](https://danbooru.donmai.us/)
-* `g` - [Gelbooru](https://gelbooru.com/)
-* `i` - [Idol Complex](https://www.idolcomplex.com/)
-* `k` - [Konachan.com](https://konachan.com/)
-* `s` - [Sankaku Channel](https://www.sankakucomplex.com/)
-* `y` - [yande.re](https://yande.re/)
+* [Safebooru](https://safebooru.donmai.us/)
+* [Danbooru](https://danbooru.donmai.us/)
+* [Gelbooru](https://gelbooru.com/)
+* [Idol Complex](https://www.idolcomplex.com/)
+* [Konachan.com](https://konachan.com/)
+* [Sankaku Channel](https://www.sankakucomplex.com/)
+* [yande.re](https://yande.re/)
## Donation