Skip to content

Commit

Permalink
📜 update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
devmount authored Sep 22, 2020
1 parent ec4e125 commit ce93e8b
Showing 1 changed file with 44 additions and 3 deletions.
47 changes: 44 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,46 @@
# ThirdStats
<p align="center">
<a href="https://devmount.de" target="_blank">
<img src='https://user-images.githubusercontent.com/5441654/93929028-837a5c00-fd1b-11ea-9ae1-3d209ccba1db.png' />
</a>
<p align="center">
A Thunderbird 78+ add-on for beautifully visualized email account stats. Download from <a href="https://addons.thunderbird.net/en-US/thunderbird/addon/thirdstats">Thunderbird Add-ons</a> repository. Contributions, corrections & requests can be made on GitHub. Created by <a href="https://github.com/devmount" target="_blank">Andreas Müller</a>.</p>
</p>

A thunderbird 78+ add-on for beautifully visualized email account stats
<p>&nbsp;</p>

*Currently in development, please don't use in production yet.*
[![release](https://img.shields.io/badge/release-v0.2.5-0a84ff.svg?style=flat-square)](https://github.com/devmount/third-stats/releases) [![last commit](https://img.shields.io/github/last-commit/devmount/third-stats?label=updated&color=0a84ff&style=flat-square)](https://github.com/devmount/third-stats/commits/master) [![license](https://img.shields.io/badge/license-MIT-e64db9.svg?style=flat-square)](./LICENSE) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-e64db9.svg?style=flat-square)](./.github/CONTRIBUTING.md)

## Get started

Install ThirdStats from the Thunderbird Add-ons repository:

1. Open the menu and click Add-ons
2. Search for *ThirdStats*
3. Click *Add to Thunderbird* and enjoy your email account stats

To properly recognize emails as *sent*, make sure to configure all email adresses you write from as identities for your email account. You can do so under *account settings* > select your account > click button *more identities* at the bottom and add or modify identities as you need.

## Features

- Total numbers of emails and folders for all of your Thunderbird accounts
- Sum of received and sent emails per year and per month
- Sum of received and sent emails per daytime and per weekday
- Temporal distribution of received and sent emails per weekday per hour
- Switch between all Thunderbird accounts

Here is how ThirdStats looks like an the Thunderbird default dark theme:

![thirdstats screenshot](https://user-images.githubusercontent.com/5441654/93931445-14066b80-fd1f-11ea-8fe7-bde8674b26f4.png)

## Additional notes

- Keep in mind, that the processing of large mailboxes can take a lot of time.
- Contributions are very welcome. If you encounter a problem, please [issue a bug report](https://github.com/devmount/third-stats/issues/new?template=bug_report.md).

## Licence

[MIT License](./LICENSE)

---

This add-on is completely free to use. If you enjoy it, please consider [donating via Paypal](https://paypal.me/devmount) or [sponsoring me](https://github.com/sponsors/devmount) for further development. :green_heart:

0 comments on commit ce93e8b

Please sign in to comment.