From ef09cc0a78a16f2cfd20292da3fccda36bfa65ca Mon Sep 17 00:00:00 2001
From: puria <puria@dyne.org>
Date: Thu, 19 Sep 2024 23:06:03 +0200
Subject: [PATCH] feat: documenting a little bit

---
 README.md | 120 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 118 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 6fc1ed6..d0385a9 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,123 @@
+<div align="center">
 
+# mattemost_commands
 
-## 📝 Site docs
+### custom dyne commands for mattermost
+
+</div>
+
+<p align="center">
+  <a href="https://dyne.org">
+    <img src="https://files.dyne.org/software_by_dyne.png" width="170">
+  </a>
+</p>
+
+
+---
+<br><br>
+
+<div id="toc">
+
+### 🚩 Table of Contents
+
+- [💾 Install](#-install)
+- [🎮 Quick start](#-quick-start)
+- [🚑 Community & support](#-community--support)
+- [😍 Acknowledgements](#-acknowledgements)
+- [👤 Contributing](#-contributing)
+- [💼 License](#-license)
+
+</div>
+
+***
+## 💾 Install
+
+Download the binary
+```bash
+wget https://github.com/dyne/mattermost_commands/releases/download/v1.1.1/mattermost_commands && chmod +x mattermost_commands
+```
+**[🔝 back to top](#toc)**
+
+***
+## 🎮 Quick start
+
+To start using mattemost_commands run the following command and run the server
 
 ```bash
-go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsite
+./mattermost_commands &
 ```
+
+test it by reach the `:4444` on the server like eg.
+
+```bash
+curl localhost:4444
+```
+
+**[🔝 back to top](#toc)**
+
+***
+## 🚑 Community & support
+
+**[📝 Documentation](#toc)** - Getting started and more.
+
+**[🌱 Ecosystem](https://github.com/dyne/ecosystem)** - Plugins, resources, and more.
+
+**[🚩 Issues](../../issues)** - Bugs end errors you encounter using mattemost_commands.
+
+**[💬 Discussions](../../discussions)** - Get help, ask questions, request features, and discuss mattemost_commands.
+
+**[[] Matrix](https://socials.dyne.org/matrix)** - Hanging out with the community.
+
+**[🗣️ Discord](https://socials.dyne.org/discord)** - Hanging out with the community.
+
+**[🪁 Telegram](https://socials.dyne.org/telegram)** - Hanging out with the community.
+
+**[📖 Example](https://github.com/mattemost_commands/example)** - An example repository that uses mattemost_commands.
+
+**[🔝 back to top](#toc)**
+
+## 😍 Acknowledgements
+
+<a href="https://dyne.org">
+  <img src="https://files.dyne.org/software_by_dyne.png" width="222">
+</a>
+
+
+Copyleft 🄯 2024 by [Dyne.org](https://www.dyne.org) foundation, Amsterdam
+
+Designed, written and maintained by Puria Nafisi Azizi.
+
+**[🔝 back to top](#toc)**
+
+***
+## 👤 Contributing
+
+1.  🔀 [FORK IT](../../fork)
+2.  Create your feature branch `git checkout -b feature/branch`
+3.  Commit your changes `git commit -am 'feat: New feature\ncloses #398'`
+4.  Push to the branch `git push origin feature/branch`
+5.  Create a new Pull Request `gh pr create -f`
+6.  🙏 Thank you
+
+
+**[🔝 back to top](#toc)**
+
+***
+## 💼 License
+    mattemost_commands - custom mattermost commands
+    Copyleft 🄯 2024 Dyne.org foundation, Amsterdam
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as
+    published by the Free Software Foundation, either version 3 of the
+    License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+**[🔝 back to top](#toc)**