Update documentation and bump version

pull/6/head v0.6.0
Michael D. M. Dryden 2021-06-20 01:53:10 -04:00
rodzic 447172ef0e
commit efd9d67a67
3 zmienionych plików z 20 dodań i 2 usunięć

Wyświetl plik

@ -7,7 +7,7 @@ The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`
and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
----------
Unreleased
`0.6.0`_ - 2021-06-20
----------
Added
-----
@ -91,3 +91,5 @@ Fixed
.. _0.3.0: https://github.com/mkdryden/telegram-stats-bot/releases/tag/v0.3.0
.. _0.3.1: https://github.com/mkdryden/telegram-stats-bot/releases/tag/v0.3.1
.. _0.4.0: https://github.com/mkdryden/telegram-stats-bot/releases/tag/v0.4.0
.. _0.5.0: https://github.com/mkdryden/telegram-stats-bot/releases/tag/v0.5.0
.. _0.6.0: https://github.com/mkdryden/telegram-stats-bot/releases/tag/v0.6.0

Wyświetl plik

@ -51,6 +51,8 @@ Table of contents
- `titles`_
- `user`_
- `corr`_
- `delta`_
@ -248,6 +250,20 @@ titles
.. image:: examples/titles.png
:alt: Example of title history plot
user
----
``/stats user`` returns basic statistics for the user.
.. code-block::
Messages sent: 16711
Average messages per day: 12.31
First message was 1357.22 days ago.
Usernames on record: 3
Average username lifetime: 452.41 days
joined on 2017-10-01 16:11:08-04:00
corr
----
``/stats corr`` returns a list of users with the highest and lowest message time correlations with the requesting user.

Wyświetl plik

@ -1,6 +1,6 @@
[tool.poetry]
name = "telegram-stats-bot"
version = "0.5.0"
version = "0.6.0"
description = "A logging and statistics bot for Telegram based on python-telegram-bot."
authors = ["Michael DM Dryden <mk.dryden@utoronto.ca>"]
repository = "https://github.com/mkdryden/telegram-stats-bot"