Skip to content

Commit

Permalink
Update documentation and bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
mkdryden committed Jun 20, 2021
1 parent 447172e commit efd9d67
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----
Expand Down Expand Up @@ -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
16 changes: 16 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ Table of contents

- `titles`_

- `user`_

- `corr`_

- `delta`_
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>"]
repository = "https://github.com/mkdryden/telegram-stats-bot"
Expand Down

0 comments on commit efd9d67

Please sign in to comment.