@@ -0,0 +1,58 @@
+# Contributing to Email CLI
+
+First off, thank you for considering contributing to Email CLI! It's people like you that make this project great.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+If you find a bug, please open an issue on our [GitHub issues page](https://github.com/andrinoff/email-cli/issues). Please include as much detail as possible, including:
+
+- A clear and descriptive title.
+- Steps to reproduce the bug.
+- What you expected to happen.
+- What actually happened.
+- Your operating system and terminal.
+
+### Suggesting Enhancements
+
+If you have an idea for a new feature or an improvement to an existing one, please open an issue on our [GitHub issues page](https://github.com/andrinoff/email-cli/issues). Please provide a clear description of the enhancement and why you think it would be a good addition.
+
+### Pull Requests
+
+We love pull requests! If you're ready to contribute code, here's how to get started:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature-name` or `git checkout -b fix/your-bug-fix`.
+3. Make your changes.
+4. Ensure your code is formatted with `go fmt ./...`.
+5. Run tests with `go test ./...`.
+6. Commit your changes with a descriptive commit message.
+7. Push your branch to your fork.
+8. Open a pull request to the `master` branch of the main repository.
+
+## Development Setup
+
+To get started with development, you'll need to have Go installed.
+
+1. Clone the repository:
+ ```bash
+ git clone https://github.com/andrinoff/email-cli.git
+ cd email-cli
+ ```
+2. Install dependencies:
+ ```bash
+ go mod tidy
+ ```
+3. Build the project:
+ ```bash
+ go build -o email-cli
+ ```
+4. Run the application:
+ ```bash
+ ./email-cli
+ ```
+
+## Code of Conduct
+
+Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Please read the [Code of Conduct](CODE_OF_CONDUCT.md).
@@ -1,8 +1,6 @@
# Email CLI 📧
-[](https://github.com/andrinoff/email-cli/actions/workflows/ci.yml)-[](https://github.com/andrinoff/email-cli/issues)-
+[](https://github.com/andrinoff/email-cli/actions/workflows/ci.yml) [](https://github.com/andrinoff/email-cli/actions/workflows/release.yml) [](https://github.com/andrinoff/email-cli/issues) [](https://github.com/andrinoff/email-cli/stargazers)
A 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!
@@ -15,59 +13,54 @@ A beautiful and functional email client for your terminal, built with Go and the
- **Compose and Send**: A simple and intuitive interface for writing and sending new emails.
- **Beautiful TUI**: A clean and modern terminal user interface that's a pleasure to use.
- **Secure**: Uses a local configuration file to store your credentials securely.
+- **Supported Providers**: Works with Gmail and iCloud.
## Getting Started 🚀
-Follow these instructions to get the email client up and running on your local machine.
+### Installation via Homebrew 🍺 (MacOS & Linux)
-### Prerequisites
+To install Email CLI using Homebrew, run the following commands:
-- **Go**: You need to have Go (version 1.18 or newer) installed on your system. You can download it from the [official Go website](https://golang.org/dl/).
+```bash
+brew tap andrinoff/email-cli
+brew install email-cli
+```
-### Installation & Setup
+After installation, run:
-1. **Clone the repository:**
+```bash
+email-cli
+```
- ```bash- git clone [https://github.com/andrinoff/email-cli.git](https://github.com/andrinoff/email-cli.git)- cd email-cli- ```
+to get started.
-2. Login
+### Build from Source 🔨
- You will have 4 input fields
+Email CLI is written in **Go**. To build it manually:
- 1. Provider (currently, `gmail` or `icloud`)- 2. Email- 3. App-specific Password (TODO: add a guide)- 4. Name to sign off (OPTIONAL, but recommended)
+1. Ensure you have Go installed (`go version`).
+2. Clone the repository:
-3. **Run the application:**- Once your `config.json` file is set up, you can run the application directly from your terminal:
```bash
- go run .
+ git clone https://github.com/andrinoff/email-cli.git
```
-## Usage ⌨️--The Email CLI is designed to be intuitive and easy to navigate with your keyboard.
+3. Navigate to the project folder:
-- **Main Menu**: Use the `Up`/`Down` arrow keys or `k`/`j` to navigate the main menu choices. Press `Enter` to select an option.-- **Inbox View**: In the inbox, use the arrow keys to scroll through your emails. Press `Enter` to open and view a selected email.-- **Composer**:- - Use `Tab` or the arrow keys to move between the "To", "Subject", and "Body" fields.- - When you are finished composing your email, navigate to the "Body" field and press `Enter` to send it.-- **Go Back/Quit**:- - Press `Esc` from any view to return to the main menu.- - Press `Ctrl+C` at any time to quit the application.
+ ```bash
+ cd email-cli
+ ```
-## Built With 🛠️
+4. Build the binary:
-This project is built with some fantastic Go libraries:
+ ```bash
+ go build -o email-cli
+ ```
-- [Bubble Tea](https://github.com/charmbracelet/bubbletea) - A powerful TUI (Text User Interface) framework.-- [Lipgloss](https://github.com/charmbracelet/lipgloss) - A library for beautiful, style-driven layouts in the terminal.-- [Bubbles](https://github.com/charmbracelet/bubbles) - A collection of ready-to-use components for Bubble Tea applications.
+5. Run it:
+ ```bash
+ ./email-cli
+ ```
## License 📄