Skip to content

Commit

Permalink
Merge pull request #4 from spkal01/patch-1
Browse files Browse the repository at this point in the history
add some basic documentation
  • Loading branch information
rexdivakar authored Oct 17, 2020
2 parents 64f8b26 + 3aaf959 commit f5a9510
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,28 @@
<p align="center">
<img src="others\bot.png" width="200" alt="Logo">

## About the package
# what is the purpose of this bot ?

This bot was created to push notifications during an event trigger !!

Telegram Bot Created to push notifications during an event trigger !!
## How to install and get started

Termux :
pkg install python3
pip3 install notifly

## Code Usage
Ubuntu/Debian
sudo apt install python3-pip
pip3 install notifly

pip install notifly
Arch

sudo pacman -S python3-pip
pip3 install notifly

# Be aware this may take a while depending on your network speed

# Documentation
from telegram import notifly

bot=notifly.BotHandler('BOT TOKEN')
Expand Down

0 comments on commit f5a9510

Please sign in to comment.