Readme

README.md

@@ -1,5 +1,68 @@
-# imapsync-web
+<h1> This project is currently under heavy development. Not ready for production </h1>
 
-## Description
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![GPL License][license-shield]][license-url]
 
-This is a web interface for imapsync. It allows you to synchronize mailboxes between two imap servers. it is based on the [imapsync](http://imapsync.lamiral.info/) command line tool. It is written in javascript and uses golang and htmx.
+[![Readme in English](https://img.shields.io/badge/Readme-English-blue)](README.md)
+[![Readme in Turkish](https://img.shields.io/badge/Readme-Turkish-red)](README.tr.md)
+
+<div align="center"> 
+<a href="https://mono.net.tr/">
+  <img src="https://monobilisim.com.tr/images/mono-bilisim.svg" width="340"/>
+</a>
+
+<h2 align="center">imapsync-web</h2>
+<b>imapsync-web</b> imapsync-web is a web interface for imapsync, providing an enterprise-ready UI for synchronizing IMAP mailboxes. This application allows admins to configure and run imapsync jobs through a browser, making it easy to keep multiple mail stores in sync. 
+</div>
+
+---
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Run](#run)
+- [Features](#features)
+- [Usage](#usage)
+- [License](#license)
+
+---
+
+## Run
+
+Just run the following command in the project directory.
+
+```bash
+go run .
+```
+
+## Features
+
+- Intuitive dashboard for managing imapsync jobs 
+- Ability to sync mail between IMAP servers | coming soon
+- Real-time progress indicators and logging
+- Email notifications on job completion | coming soon
+- Self-hosted, open-source solution
+
+## Usage
+
+- /admin endpoint is used for admin operations.
+
+---
+
+## License
+
+inapsync-web is GPL-3.0 licensed. See [LICENSE](LICENSE) file for details.
+
+[contributors-shield]: https://img.shields.io/github/contributors/monobilisim/imapsync-web.svg?style=for-the-badge
+[contributors-url]: https://github.com/monobilisim/imapsync-web/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/monobilisim/imapsync-web.svg?style=for-the-badge
+[forks-url]: https://github.com/monobilisim/imapsync-web/network/members
+[stars-shield]: https://img.shields.io/github/stars/monobilisim/imapsync-web.svg?style=for-the-badge
+[stars-url]: https://github.com/monobilisim/imapsync-web/stargazers
+[issues-shield]: https://img.shields.io/github/issues/monobilisim/imapsync-web.svg?style=for-the-badge
+[issues-url]: https://github.com/monobilisim/imapsync-web/issues
+[license-shield]: https://img.shields.io/github/license/monobilisim/imapsync-web.svg?style=for-the-badge
+[license-url]: https://github.com/monobilisim/imapsync-web/blob/master/LICENSE