Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rking32 committed Dec 28, 2020
1 parent 0d042d6 commit 4fa6045
Showing 1 changed file with 8 additions and 71 deletions.
79 changes: 8 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
<br>
<b>Pluggable Telegram UserBot</b>
<br>
<a href="https://github.com/UsergeTeam/Userge#documentation-">Documentation</a>
&nbsp•&nbsp
<a href="https://github.com/UsergeTeam/Userge#inspiration-">Inspiration</a>
&nbsp•&nbsp
<a href="https://github.com/UsergeTeam/Userge#features-">Features</a>
&nbsp•&nbsp
<a href="https://github.com/UsergeTeam/Userge#example-plugin-">Example</a>
&nbsp•&nbsp
<a href="https://github.com/UsergeTeam/Userge#requirements-">Requirements</a>
&nbsp•&nbsp
<a href="https://github.com/UsergeTeam/Userge#project-credits-">Project Credits</a>
&nbsp•&nbsp
<a href="https://github.com/UsergeTeam/Userge#copyright--license-">Copyright & License</a>
Expand Down Expand Up @@ -40,78 +40,21 @@

> **Userge** is a Powerful , _Pluggable_ Telegram UserBot written in _Python_ using [Pyrogram](https://github.com/pyrogram/pyrogram).
## Documentation 📘

> you can find full documentation [**here**](https://theuserge.github.io)
## Inspiration 😇

> This project is inspired by the following projects :)
* [tg_userbot](https://github.com/watzon/tg_userbot) ( heavily ) 🤗
* [PyroGramUserBot](https://github.com/SpEcHiDe/PyroGramUserBot)
* [PyroGramBot](https://github.com/SpEcHiDe/PyroGramBot)
* [Telegram-Paperplane](https://github.com/RaphielGang/Telegram-Paperplane)
* [UniBorg](https://github.com/SpEcHiDe/UniBorg)

> Special Thanks to all of you !!!.
## Features 😍

* Powerful and Very Useful **built-in** Plugins
* gdrive [ upload / download / etc ] ( Team Drives Supported! ) 🤥
* zip / tar / unzip / untar / unrar
* telegram upload / download
* pmpermit / afk
* notes / filters
* split / combine
* gadmin
* plugin manager
* ...and more
* Channel & Group log support
* Database support
* Build-in help support
* Easy to Setup & Use
* Easy to add / port Plugins
* Easy to write modules with the modified client

## Example Plugin 🤨

```python
from userge import userge, Message, filters

LOG = userge.getLogger(__name__) # logger object
CHANNEL = userge.getCLogger(__name__) # channel logger object

# add command handler
@userge.on_cmd("test", about="help text to this command")
async def test_cmd(message: Message):
LOG.info("starting test command...") # log to console
# some other stuff
await message.edit("testing...", del_in=5) # this will be automatically deleted after 5 sec
# some other stuff
await CHANNEL.log("testing completed!") # log to channel

# add filters handler
@userge.on_filters(filters.me & filters.private) # filter my private messages
async def test_filter(message: Message):
LOG.info("starting filter command...")
# some other stuff
await message.reply(f"you typed - {message.text}", del_in=5)
# some other stuff
await CHANNEL.log("filter executed!")
```

## Requirements 🥴

* Python 3.8 or Higher 👻
* Telegram [API Keys](https://my.telegram.org/apps)
* Google Drive [API Keys](https://console.developers.google.com/)
* MongoDB [Database URL](https://cloud.mongodb.com/)

## UserGe MODES 🕹

* **USER** mode `(using user account)`
* **BOT** mode `(using bot account)`
* **DUAL** mode `(using both user and bot account)`

> further **read** [config.env.sample](https://github.com/UsergeTeam/Userge/blob/alpha/config.env.sample)
## How To Deploy 👷

* [**With Heroku 🇭**](https://theuserge.github.io/deployment#deploying-with-heroku)
Expand All @@ -121,7 +64,6 @@ async def test_filter(message: Message):

* [**With Git, Python and pip 🔧**](https://theuserge.github.io/deployment#deploying-with-legacy-method)


### Video Tutorial 🎥

[![Tutorial](resources/tutorial.jpg)](https://youtu.be/M4T_BJvFqkc "Tutorial")
Expand All @@ -133,12 +75,7 @@ async def test_filter(message: Message):
### Project Credits 💆‍♂️

* [Specially to these projects](https://github.com/UsergeTeam/Userge#inspiration-) 🥰
* [@uaudIth](https://t.me/uaudIth)
* [@K_E_N_W_A_Y](https://t.me/K_E_N_W_A_Y)
* [@nawwasl](https://t.me/nawwasl)
* [@TharukaN97](https://t.me/TharukaN97)
* [@Supun97](https://t.me/Supun97)
* [@gotstc](https://t.me/gotstc)
* [Contributors](https://github.com/UsergeTeam/Userge/graphs/contributors) 👥

### Copyright & License 👮

Expand Down

0 comments on commit 4fa6045

Please sign in to comment.