update docs

README.md

@@ -1,8 +1,24 @@
-### MAILPASS
+![Logo](https://github.com/codaholichq/mailpass/blob/main/docs/banner.webp)
 
-Welcome to your new `MailPass` project and the Internet Computer development community. By default, creating a new project adds this README and some template files to your project directory. You can edit these template files to customize your project and include your code to speed up the development cycle.
+<div align="center">
+	<img alt="status" src="https://github.com/codaholichq/mailpass/actions/workflows/cargo.yml/badge.svg?branch=main">
+    <img alt="status" src="https://img.shields.io/badge/status-developing-brightgree">
+	<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/codaholichq/mailpass">
+	<img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/codaholichq/mailpass">
+	<img alt="GitHub stars" src="https://img.shields.io/github/stars/codaholichq/mailpass">
+	<img alt="visitors" src="https://visitor-badge.laobi.icu/badge?page_id=mailpass">
+	<a href="https://x.com/intent/tweet?hashtags=mailpass,rust,axum,oss&text=A+service+that+checkes+if+email+address+exist+without+sending+a+mail&url=https%3A%2F%2Fgithub.com%2Fcodaholichq%2Fmailpass&via=codaholichq">
+		<img alt="𝕏" src="https://img.shields.io/twitter/url/http/shields.io.svg?style=flat&logo=twitter">
+	</a>
+</div>
 
-To get started, you might want to explore the project directory structure and the default configuration file. Working with this project in your development environment will not affect any production deployment or identity tokens.
+<br/>
+
+Welcome to `MailPass`, a web application that checks if an email address exists before sending any email.
+
+Read the [Changelog file](https://github.com/codaholichq/mailpass/blob/main/docs/CHANGELOG.md) to see the new changes.
+
+Clone this repository to get the latest unreleased version.
 
 To learn more before you start working with `MailPass`, see the following documentation available online:
 
@@ -13,6 +29,27 @@ To learn more before you start working with `MailPass`, see the following docume
 - [ic-cdk-macros](https://docs.rs/ic-cdk-macros)
 - [Candid Introduction](https://internetcomputer.org/docs/current/developer-docs/backend/candid/)
 
+
+## Purpose of this Project
+This project helps newsletter owners to:
+- Prevent email from getting blacklisted
+- Spot emails that don't exist
+- Fish out trash emails
+
+## Technologies
+- Rust 1.80.1
+- Axum 0.7.5
+- Tokio 1.39.2
+- Vue 3.3.4
+- Pinia 2.1.6
+- DFinity
+- VSCode 1.92.1
+
+## Features
+- [x] Swagger
+- [x] Concurrency
+- [x] Message Queuing
+
 If you want to start working on your project right away, you might want to try the following commands:
 
 ```bash
@@ -59,3 +96,23 @@ If you are hosting frontend code somewhere without using DFX, you may need to ma
 - use your preferred method to replace `process.env.DFX_NETWORK` in the autogenerated declarations
   - Setting `canisters -> {asset_canister_id} -> declarations -> env_override to a string` in `dfx.json` will replace `process.env.DFX_NETWORK` with the string in the autogenerated declarations
 - Write your `createActor` constructor
+
+## Bugs? Suggestions?
+Having any issues or trouble getting started? [Get in touch with me](https://www.codaholic.com/contact) or [Raise a Bug or Feature Request](https://github.com/codaholichq/configa/issues/new/choose). Always happy to help.
+
+## Give a Star ⭐
+If you find this project helpful, do give it a star. Thanks! <br/>
+If you are feeling really generous, send me ETH: <code>0x9F4942911f2406E5897669Db99184d47B3078E99</code>
+
+## Share it!
+There are many improvements and fixes along the way from the day I started out. Thanks to the community for the support and suggestions.
+Please share this Repository within your developer community, if you think this would make a difference! Thanks.
+
+## About the Author
+### Emmy Steven
+- Blogs [codaholic.com](https://www.codaholic.com)
+- Linkedin - [Emmy Steven](https://www.linkedin.com/in/emmysteven/)
+- 𝕏 - [Emmy Steven](https://x.com/emmystevenx)
+
+## Licensing
+This project is licensed with the [MIT License](https://github.com/codaholichq/mailpass/blob/main/docs/LICENSE).