README.md

 1<div align="center">
 2
 3---
 4
 5<img src = "assets/logo.png" width=200 height=200>
 6
 7```
 8             __       __
 9    ____ ___  ____ _/ /______/ /_  ____ _
10    / __ '__ \/ __ '/ __/ ___/ __ \/ __ '/
11  / / / / / / /_/ / /_/ /__/ / / / /_/ /
12/_/ /_/ /_/\__,_/\__/\___/_/ /_/\__,_/
13```
14
15---
16
17[![Go CI](https://github.com/floatpane/matcha/actions/workflows/ci.yml/badge.svg)](https://github.com/floatpane/matcha/actions/workflows/ci.yml)
18[![Go Release](https://github.com/floatpane/matcha/actions/workflows/release.yml/badge.svg)](https://github.com/floatpane/matcha/actions/workflows/release.yml)
19[![Go Version](https://img.shields.io/github/go-mod/go-version/floatpane/matcha)](https://golang.org)
20[![Go Report Card](https://goreportcard.com/badge/github.com/floatpane/matcha)](https://goreportcard.com/report/github.com/floatpane/matcha)
21[![GitHub release (latest by date)](https://img.shields.io/github/v/release/floatpane/matcha)](https://github.com/floatpane/matcha/releases)
22[![GitHub All Releases](https://img.shields.io/github/downloads/floatpane/matcha/total)](https://github.com/floatpane/matcha/releases)
23[![GitHub license](https://img.shields.io/github/license/floatpane/matcha)](https://github.com/floatpane/matcha/blob/master/LICENSE)
24
25**A powerful, feature-rich email client for your terminal.** Built with Go and the Bubble Tea TUI framework, Matcha brings a beautiful, modern email experience to the command line with support for rich content, multiple accounts, and advanced terminal features.
26
27</div>
28
29![Demo GIF](public/assets/demo.gif)
30
31## Documentation
32
33- **[Installation Guide](docs/INSTALLATION.md)**: Steps to get Matcha running on your system.
34- **[Configuration](docs/CONFIGURATION.md)**: Detailed configuration options and file locations.
35- **[Usage & Keybindings](docs/USAGE.md)**: How to use Matcha, including keyboard shortcuts.
36
37## Features
38
39Explore the detailed documentation for Matcha's features:
40
41- **[Email Management](docs/features/EMAIL_MANAGEMENT.md)**: Inbox, sent mail, search, and rich viewing.
42- **[Image Compatibility](docs/features/images/COMPATABILITY.md)**: Support for modern terminal image protocols.
43- **[Composing Emails](docs/features/COMPOSING.md)**: Writing, attachments, and markdown support.
44- **[Draft Management](docs/features/DRAFTS.md)**: saving and resuming drafts.
45- **[Account Management](docs/features/ACCOUNTS.md)**: Managing multiple accounts and providers.
46- **[Contact Management](docs/features/CONTACTS.md)**: Address book and auto-saving.
47- **[User Interface](docs/features/UI.md)**: TUI design and customization.
48- **[Advanced Features](docs/features/ADVANCED.md)**: Updates, caching, and debugging.
49
50## Contributing
51
52Contributions are welcome! Please feel free to submit a Pull Request. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
53
54## License
55
56This project is distributed under the MIT License. See the `LICENSE` file for more information.
57
58---
59
60<div align="center">
61
62**[Report Bug](https://github.com/floatpane/matcha/issues/new?template=bug_report.md)** · **[Request Feature](https://github.com/floatpane/matcha/issues/new?template=feature_request.md)** · **[Contributing Guidelines](https://github.com/floatpane/matcha/blob/master/CONTRIBUTING.md)**
63
64</div>