randogoth/lxmf-bot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fixed missing folder, more instance options

Browse source
This commit is contained in:
randogoth 2023-05-24 16:37:56 +03:00
parent 95ec09a41b
commit de29ddb054
2 changed files with 13 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -10,7 +10,8 @@ $ pip install -r requirements.txt
## Usage
- Instantiate the class with a name for the bot as parameter
- Instantiate the class with a `name` for the bot as parameter.
- Two additional options the class takes as parameters are `announce` to define the announce interval in seconds (defaults to `360`) and an `announce_immediately` boolean to define whether the bot should announce itself immediately after instantiation or not (defaults to `False`)
- Use the `received` decorator to define functions for parsing received messages
- Use the `<instance>.send(recipient_hash, message)` or `msg.reply(message)` methods to send messages
- Launch the bot using the `run` method