diff --git a/README.md b/README.md index 588c242afe167d4b69612d776f581336d9f68145..1be9be9a79243ac7510678c8b21ee4039556556f 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,14 @@ --- - - -``` - __ __ - ____ ___ ____ _/ /______/ /_ ____ _ - / __ '__ \/ __ '/ __/ ___/ __ \/ __ '/ - / / / / / / /_/ / /_/ /__/ / / / /_/ / -/_/ /_/ /_/\__,_/\__/\___/_/ /_/\__,_/ -``` + --- -[![Go CI](https://github.com/floatpane/matcha/actions/workflows/ci.yml/badge.svg)](https://github.com/floatpane/matcha/actions/workflows/ci.yml) -[![Go Release](https://github.com/floatpane/matcha/actions/workflows/release.yml/badge.svg)](https://github.com/floatpane/matcha/actions/workflows/release.yml) [![Go Version](https://img.shields.io/github/go-mod/go-version/floatpane/matcha)](https://golang.org) [![Go Report Card](https://goreportcard.com/badge/github.com/floatpane/matcha)](https://goreportcard.com/report/github.com/floatpane/matcha) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/floatpane/matcha)](https://github.com/floatpane/matcha/releases) -[![GitHub All Releases](https://img.shields.io/github/downloads/floatpane/matcha/total)](https://github.com/floatpane/matcha/releases) -[![GitHub license](https://img.shields.io/github/license/floatpane/matcha)](https://github.com/floatpane/matcha/blob/master/LICENSE) +[![Go Reference](https://pkg.go.dev/badge/github.com/floatpane/matcha.svg)](https://pkg.go.dev/github.com/floatpane/matcha) **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. @@ -30,22 +19,11 @@ ## Documentation -- **[Installation Guide](docs/INSTALLATION.md)**: Steps to get Matcha running on your system. -- **[Configuration](docs/CONFIGURATION.md)**: Detailed configuration options and file locations. -- **[Usage & Keybindings](docs/USAGE.md)**: How to use Matcha, including keyboard shortcuts. - -## Features +Matcha Documention is available on [https://docs.matcha.floatpane.com](our website) -Explore the detailed documentation for Matcha's features: +## Star History -- **[Email Management](docs/features/EMAIL_MANAGEMENT.md)**: Inbox, sent mail, search, and rich viewing. -- **[Image Compatibility](docs/features/images/COMPATABILITY.md)**: Support for modern terminal image protocols. -- **[Composing Emails](docs/features/COMPOSING.md)**: Writing, attachments, and markdown support. -- **[Draft Management](docs/features/DRAFTS.md)**: saving and resuming drafts. -- **[Account Management](docs/features/ACCOUNTS.md)**: Managing multiple accounts and providers. -- **[Contact Management](docs/features/CONTACTS.md)**: Address book and auto-saving. -- **[User Interface](docs/features/UI.md)**: TUI design and customization. -- **[Advanced Features](docs/features/ADVANCED.md)**: Updates, caching, and debugging. +[![Star History Chart](https://api.star-history.com/svg?repos=floatpane/matcha&type=date&legend=top-left)](https://www.star-history.com/#floatpane/matcha&type=date&legend=top-left) ## Contributing diff --git a/assets/banner.jpg b/assets/banner.jpg new file mode 100644 index 0000000000000000000000000000000000000000..51502efacea7ed1b8852039105c7841496dbb427 Binary files /dev/null and b/assets/banner.jpg differ