1# Matcha 🍵
  2
  3<div align="center">
  4
  5---
  6
  7<img src = "assets/logo.png" width=200 height=200>
  8
  9---
 10
 11[![Go CI](https://github.com/floatpane/matcha/actions/workflows/ci.yml/badge.svg)](https://github.com/floatpane/matcha/actions/workflows/ci.yml)
 12[![Go Release](https://github.com/floatpane/matcha/actions/workflows/release.yml/badge.svg)](https://github.com/floatpane/matcha/actions/workflows/release.yml)
 13[![GoReleaser](https://img.shields.io/badge/GoReleaser-blue?logo=goreleaser)](https://goreleaser.com)
 14[![Go Version](https://img.shields.io/github/go-mod/go-version/floatpane/matcha)](https://golang.org)
 15[![Go Report Card](https://goreportcard.com/badge/github.com/floatpane/matcha)](https://goreportcard.com/report/github.com/floatpane/matcha)
 16
 17[![GitHub release (latest by date)](https://img.shields.io/github/v/release/floatpane/matcha)](https://github.com/floatpane/matcha/releases)
 18[![GitHub All Releases](https://img.shields.io/github/downloads/floatpane/matcha/total)](https://github.com/floatpane/matcha/releases)
 19[![GitHub stars](https://img.shields.io/github/stars/floatpane/matcha)](https://github.com/floatpane/matcha/stargazers)
 20[![GitHub issues](https://img.shields.io/github/issues/floatpane/matcha)](https://github.com/floatpane/matcha/issues)
 21[![GitHub license](https://img.shields.io/github/license/floatpane/matcha)](https://github.com/floatpane/matcha/blob/master/LICENSE)
 22
 23[![macOS](https://img.shields.io/badge/macOS-Supported-000000?logo=macos&logoColor=white)](https://www.apple.com/macos)
 24[![Linux](https://img.shields.io/badge/Linux-Supported-FCC624?logo=linux&logoColor=black)](https://www.linux.org/)
 25[![Homebrew](https://img.shields.io/badge/homebrew-tap-21648C.svg?logo=homebrew)](https://brew.sh)
 26[![Snapcraft](https://img.shields.io/badge/snap-available-82BEA0.svg?logo=snapcraft)](https://snapcraft.io/matcha)
 27
 28[![Patreon](https://img.shields.io/badge/Patreon-F96854?logo=patreon&logoColor=white)](https://patreon.com/andrinoff)
 29[![GitHub contributors](https://img.shields.io/github/contributors/floatpane/matcha)](https://github.com/floatpane/matcha/graphs/contributors)
 30[![Built with Bubble Tea](https://img.shields.io/badge/Built%20with-Bubble%20Tea-FF75B7.svg)](https://github.com/charmbracelet/bubbletea)
 31
 32A beautiful and functional email client for your terminal, built with Go and the charming Bubble Tea TUI library. Never leave your command line to check your inbox or send an email again!
 33
 34![Main Menu Screenshot](assets/preview.png)
 35
 36</div>
 37
 38## Features ✨
 39
 40- **View Your Inbox**: Fetches and displays a list of your most recent emails.
 41- **Read Emails**: Select an email from your inbox to view its content.
 42- **Compose and Send**: A simple and intuitive interface for writing and sending new emails.
 43- **Beautiful TUI**: A clean and modern terminal user interface that's a pleasure to use.
 44- **Secure**: Uses a local configuration file to store your credentials securely.
 45- **Supported Providers**: Works with Gmail and iCloud.
 46
 47## Installation 🚀
 48
 49There are several ways to install Matcha.
 50
 51### Package Managers
 52
 53#### Homebrew 🍺 (macOS & Linux)
 54
 55```bash
 56brew tap floatpane/matcha
 57brew install matcha
 58```
 59
 60After installation, run:
 61
 62```bash
 63matcha
 64```
 65
 66to get started.
 67
 68### Install using Snap
 69
 70```bash
 71sudo snap install matcha
 72```
 73
 74### Build from Source 🔨
 75
 76Matcha is written in **Go**. To build it manually:
 77
 781.  Ensure you have Go installed (`go version`).
 792.  Clone the repository:
 80
 81    ```bash
 82    git clone https://github.com/floatpane/matcha.git
 83    ```
 84
 853.  Navigate to the project folder:
 86
 87    ```bash
 88    cd matcha
 89    ```
 90
 914.  Build the binary:
 92
 93    ```bash
 94    go build -o matcha
 95    ```
 96
 975.  Run it:
 98    ```bash
 99    ./matcha
100    ```
101
102## License 📄
103
104This project is distributed under the MIT License. See the `LICENSE` file for more information.