Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,18 @@ pip install tg-ringer

Requires Python 3.9+.

### Also available in other languages 🌍

| Language | Install | Downloads |
|----------|---------|-----------|
| 🐍 Python | `pip install tg-ringer` | [PyPI](https://pypi.org/project/tg-ringer/) |
| 🐹 Go | `go install github.com/jdp5949/tg-ringer-go/cmd/tg-ringer@latest` | [binaries](https://github.com/jdp5949/tg-ringer-go/releases) |
| 🟢 Node/TS | `npm install github:jdp5949/tg-ringer-js` | [tarball](https://github.com/jdp5949/tg-ringer-js/releases) |
| ☕ Java | JitPack `com.github.jdp5949:tg-ringer-java:v0.1.0` | [jars](https://github.com/jdp5949/tg-ringer-java/releases) |
| 🦀 Rust | `cargo install --git https://github.com/jdp5949/tg-ringer-rs` | [binaries](https://github.com/jdp5949/tg-ringer-rs/releases) |

Full docs & use cases: **https://jdp5949.github.io/tg-ringer/**

---

## Setup (one command)
Expand Down
39 changes: 39 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,25 @@ Telegram account you already have, with zero monthly cost.

---

## Available in 5 languages 🌍

Same tool, your stack. Pick a language — each has its own repo, CI, and downloadable
builds on GitHub (no account or token needed to install).

| Language | Install | Downloads |
|----------|---------|-----------|
| 🐍 **Python** | `pip install tg-ringer` | [PyPI](https://pypi.org/project/tg-ringer/) |
| 🐹 **Go** | `go install github.com/jdp5949/tg-ringer-go/cmd/tg-ringer@latest` | [binaries](https://github.com/jdp5949/tg-ringer-go/releases) (Linux/macOS/Windows) |
| 🟢 **Node/TS** | `npm install github:jdp5949/tg-ringer-js` | [tarball](https://github.com/jdp5949/tg-ringer-js/releases) |
| ☕ **Java** | JitPack: `com.github.jdp5949:tg-ringer-java:v0.1.0` | [jars](https://github.com/jdp5949/tg-ringer-java/releases) |
| 🦀 **Rust** | `cargo install --git https://github.com/jdp5949/tg-ringer-rs` | [binaries](https://github.com/jdp5949/tg-ringer-rs/releases) |

> Python is the reference implementation (live-tested). Go is a native gotd/td port.
> Java and Rust wrap the native Go binary. Node is a native GramJS port. The Go/Node/Rust/Java
> ports are **beta** — same logic as Python, community testing welcome. 🙏

---

## How it works

```mermaid
Expand Down Expand Up @@ -194,6 +213,26 @@ never spam. Check status via `@SpamBot`. You use this at your own risk.

---

## 💛 Help & contributing

We're genuinely happy to help you get this working — it's free, open source (MIT),
and built to be useful. If you're stuck or have an idea:

- **Questions / bugs** → open an issue on the repo for your language:
[Python](https://github.com/jdp5949/tg-ringer/issues) ·
[Go](https://github.com/jdp5949/tg-ringer-go/issues) ·
[Node](https://github.com/jdp5949/tg-ringer-js/issues) ·
[Java](https://github.com/jdp5949/tg-ringer-java/issues) ·
[Rust](https://github.com/jdp5949/tg-ringer-rs/issues)
- **Pull requests welcome** — docs, fixes, new language ports, real-world testing of
the beta ports. No contribution is too small.
- **New to Telegram userbots?** Start with the [Quick start](#quick-start-3-steps)
above; the `login` command walks you through everything.

If something in these docs is unclear, that's on us — tell us and we'll fix it. 🙌

---

## FAQ

**Is this a bot?** No — it's a *userbot* (your real account). Bots can't call.
Expand Down
Loading