Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
- add links to badges
- change introduction
  • Loading branch information
tm-a-t committed Nov 24, 2022
1 parent 6256c89 commit a321bbf
Showing 1 changed file with 10 additions and 18 deletions.
28 changes: 10 additions & 18 deletions README.md
@@ -1,19 +1,19 @@
# TGPy

_Run Python code right in your Telegram messages_

![PyPI](https://img.shields.io/pypi/v/tgpy)
![Docker Image Version (latest semver)](https://img.shields.io/docker/v/tgpy/tgpy?label=docker&sort=semver)
![Open issues](https://img.shields.io/github/issues-raw/tm-a-t/TGPy)
![Docs](https://img.shields.io/website?label=docs&url=https%3A%2F%2Ftgpy.tmat.me)
[![PyPI](https://img.shields.io/pypi/v/tgpy)](https://pypi.org/project/tgpy/)
[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/tgpy/tgpy?label=docker&sort=semver)](https://hub.docker.com/r/tgpy/tgpy)
[![Open issues](https://img.shields.io/github/issues-raw/tm-a-t/TGPy)](https://github.com/tm-a-t/TGPy/issues)
[![Docs](https://img.shields.io/website?label=docs&url=https%3A%2F%2Ftgpy.tmat.me)](https://tgpy.tmat.me/)
<!-- ![PyPI - Downloads](https://img.shields.io/pypi/dm/tgpy) -->

TGPy is a tool for running Python expressions and Telegram API scripts, built on top of [Telethon](https://github.com/LonamiWebs/Telethon).
**Run Python code right in your Telegram messages.** TGPy is a tool built on top of [Telethon](https://github.com/LonamiWebs/Telethon).

- Do Python calculations in dialogs
- Use code to send messages, save files, analyze chats and more
- Calculate right in chats
- Send messages, save files, analyze chats &mdash; with simple code
- Set up functions to automate your Telegram actions

[Basics Guide](http://tgpy.tmat.me/basics/code/) · [Extensibility Guide](http://tgpy.tmat.me/extensibility/context/) · [Reference](http://tgpy.tmat.me/reference/builtins/)

## Getting started

Python 3.9+ required. Install TGPy and connect it to your Telegram account:
Expand All @@ -25,18 +25,10 @@ Python 3.9+ required. Install TGPy and connect it to your Telegram account:

You’re ready now. Send Python code to any chat, and it will run. Change your message to change the result.

Details on installation: http://tgpy.tmat.me/installation/
[Details on installation](http://tgpy.tmat.me/installation/)

https://user-images.githubusercontent.com/38432588/181266550-c4640ff1-71f2-4868-ab83-6ea3690c01b6.mp4

## New TGPy docs

**[Basics Guide:](http://tgpy.tmat.me/basics/code/)** All you need to know to start using TGPy.

**[Extensibility Guide:](http://tgpy.tmat.me/extensibility/context/)** Special features for advanced usage.

**[Reference:](http://tgpy.tmat.me/reference/builtins/)** List of TGPy objects and settings.

## Inspiration

TGPy is inspired by [FTG](https://gitlab.com/friendly-telegram/friendly-telegram) and similar userbots. However, the key concept is different: TGPy is totally based on usage of code in Telegram rather than plugging extra modules. This leads both to convenience of single-use scripts and reusage flexibility.
Expand Down

0 comments on commit a321bbf

Please sign in to comment.