Add readme

README.md

@@ -1,2 +1,35 @@
-# MailFox
- A streamlined IMAP integrated email classifier
+<h1 align="center">
+<img src="assets/banner.png" width="300">
+</h1><br>
+
+![GitHub Release](https://img.shields.io/github/v/release/stelath/mailfox)
+![GitHub License](https://img.shields.io/github/license/stelath/mailfox)
+
+Mailfox is a simple and fast ai powered email toolkit to enhance you email workflow.
+
+## Getting Started
+### Installation
+Run `pip install mailfox` to get started!
+
+### Set Up
+To setup mailfox you can simply run the `mailfox init` command which will launch you into a guided setup wizard:
+
+The wizard will guiide you through the following steps:
+* **Setting Credentials**: You'll be prompted to enter your email address and password. Optionally, you can enter an API key if you plan to use the LLM classifier.
+
+* **Configuring Paths**: You'll be prompted to set paths for the email database and clustering data. You can also specify any flagged folders and set the default classifier (either "clustering" or "llm").
+
+* **Downloading Emails**: You'll be asked if you'd like to download your emails to the VectorDB immediately.
+
+
+
+## Features
+### Classification
+
+Classify emails into categories such as `Social`, `Promotions`, `Updates`, `Forums`, `Purchases`, `Spam` and `Others`.
+
+When the `mailfox run` command is executed, it will classify all unread emails in your inbox and move them to the corresponding folder. It will then sleep for 5 minutes and repeat the process.
+
+### Search
+
+Coming Soon...

pyproject.toml

@@ -0,0 +1,35 @@
+[tool.poetry]
+name = "mailfox"
+version = "0.1.4"
+description = "Mailfox is a simple and fast ai powered email toolkit to enhance you email workflow"
+authors = ["Alex Korte <alex.k.korte@gmail.com>"]
+license = "GNU GPLv3"
+readme = "README.md"
+packages = [{include = "mailfox"}]
+repository = "https://github.com/stelath/mailfox"    # Update with your project's repository URL
+
+[tool.poetry.dependencies]
+python = "^3.8"
+typer = ">=0.3.2,<1.0.0"
+pyyaml = ">=6.0,<7.0"
+
+[tool.poetry.scripts]
+mailfox = "mailfox.__main__:main"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.isort]
+profile = "black"
+
+[tool.black]
+line-length = 88
+
+[tool.mypy]
+python_version = "3.8"
+files = "mailfox"
+
+[tool.flake8]
+max-line-length = 88
+extend-ignore = "E203,W503"