add standard documents

AUTHORS.md

@@ -1,10 +1,12 @@
-# Authors #
+# Authors
 
-----------
-- AmirHosein Rostami  - Open Science Laboratory ([Github](https://github.com/AHReccese)) **
+---
 
+-   AmirHosein Rostami - Open Science Laboratory ([Github](https://github.com/AHReccese))
+-   Fatemeh Shahali ([Github](https://github.com/F-Shahali)) \*\*
 
-** **Maintainer**
+\*\* **Maintainer**
 
-# Other Contributors #
-----------
+# Other Contributors
+
+---

CHANGELOG.md

@@ -1,19 +1,20 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-## [0.1] - 202x-xx-xx
+
+## [0.1] - 2024-xx-xx
+
 ### Added
-- Item1
-- Item2
-- Item3
-### Changed 
-- Item1
-- Item2
-- Item3
+
+-   `Email` support
+-   `Gmail` support
+-   `Telegram` support
+-   Choose direct or indirect sharing mode
 
 [Unreleased]: https://github.com/openscilab/mybutton/compare/v0.1...dev
-[0.1]: https://github.com/openscilab/mybutton/compare/c6df6cc...v0.1
+[0.1]: https://github.com/openscilab/mybutton/compare/c6df6cc...v0.1

README.md

@@ -1 +1,50 @@
-# mybutton
+## Table of contents
+
+-   [Overview](https://github.com/openscilab/mybutton#overview)
+-   [Supported Services](https://github.com/openscilab/mybutton#supported-services)
+-   [Issues & Bug Reports](https://github.com/openscilab/mybutton#issues--bug-reports)
+-   [Contribution](https://github.com/openscilab/mybutton/blob/main/.github/CONTRIBUTING.md)
+-   [Authors](https://github.com/openscilab/mybutton/blob/main/AUTHORS.md)
+-   [License](https://github.com/openscilab/mybutton/blob/main/LICENSE)
+-   [Show Your Support](https://github.com/openscilab/mybutton#show-your-support)
+-   [Changelog](https://github.com/openscilab/mybutton/blob/main/CHANGELOG.md)
+-   [Code of Conduct](https://github.com/openscilab/mybutton/blob/main/.github/CODE_OF_CONDUCT.md)
+
+## Overview
+
+MyButton is an open-source project that streamlines the process of sharing links to your preferred online services. It provides a user-friendly interface that allows users to seamlessly share content with just a few clicks. MyButton takes care of the technical aspects. Depending on the chosen service, it might:
+
+-   Redirect you directly to the platform with the link pre-populated.
+-   Generate sharable buttons embedded with your link. Clicking these buttons redirects users to the chosen service.
+
+## Supported services
+
+| Service name | Support  |
+| ------------ | -------- |
+| Email        | ✅ |
+| Gmail        | ✅ |
+| Telegram     | ✅ |
+
+## Issues & bug reports
+
+Just fill an issue and describe it. We'll check it ASAP! or send an email to [[email protected]](mailto:[email protected] '[email protected]').
+
+-   Please complete the issue template
+
+You can also join our discord server
+
+<a href="https://discord.gg/JpvX3DQx">
+  <img src="https://img.shields.io/discord/1064533716615049236.svg?style=for-the-badge" alt="Discord Channel">
+</a>
+
+## Show Your Support
+
+<h3>Star this repo</h3>
+
+Give a ⭐️ if this project helped you!
+
+<h3>Donate to our project</h3>
+
+If you do like our project and we hope that you do, can you please support us? Our project is not and is never going to be working for profit. We need the money just so we can continue doing what we do ;-) .
+
+<a href="https://openscilab.com/#donation" target="_blank"><img src="https://github.com/openscilab/mybutton/raw/main/otherfiles/donation.png" height="90px" width="270px" alt="mybutton Donation"></a>