✨: update magicc documentation

Author: warengonzaga

README.md

@@ -8,6 +8,54 @@ You can do `magicc`, you can build anything that you desire. 🪄🔮💻
 
 Have suggestions in mind? [Let me know!](https://github.com/warengonzaga/magic-commit/issues)
 
+> [!IMPORTANT]  
+> This project is still in it's early stage so expect some bugs and issues. Please report any issues you encounter. Thank you! 🙏
+
+## 🕹️ Usage
+
+Save all of your changes and after that run the following command:
+
+```bash
+magicc
+```
+
+This will automatically stage your changes by file and commit them one by one. All you need to do is type `magicc` and accept if you love the suggested commit message in every changed files. 🪄
+
+> [!NOTE]  
+> To be able to make it work it requires API key from [OpenAI](https://openai.com) to use the GPT-3 model. You can get your API key by signing up to their website. Once you have the API key, you can set it up by running the following command:
+>
+> ```bash
+> magicc -s=<api-key>
+> ```
+>
+> This will save your API key to the configuration file and you can now use the `magicc` command. I'm considering to find a provider that offers free API key for this project. 🙏 _(if you are reading this [contact me](mailto:opensource@warengonzaga.com).)_
+
+## 📦 Installation
+
+You can install this project via `npm` or `yarn`.
+
+```bash
+npm install -g magicc
+```
+
+or
+
+```bash
+yarn global add magicc
+```
+
+## 💖 Motivation
+
+I created this project because I wanted a simple and easy-to-use tool that follows my own git commit standard by default. Additionally, I wanted to learn how to build AI-based developer tools. The goal of this project is to provide a user-friendly experience for everyone. If you're looking for more advanced features, I recommend checking out the other projects mentioned below. 🙏
+
+This project is inspired by the following projects:
+
+- [aicommits](https://github.com/Nutlope/aicommits) - A CLI that writes your git commit messages for you with AI.
+- [ai-commit](https://github.com/insulineru/ai-commit) - Make commits easier with ChatGPT, Gitmoji and Conventional Commits.
+- [opencommit](https://github.com/di-sukharev/opencommit) - About
+Auto-generate impressive commits with AI in 1 second.
+- [tgpt](https://github.com/aandrew-me/tgpt) - AI Chatbots in terminal without needing API keys.
+
 ## 🎯 Contributing
 
 Contributions are welcome, create a pull request to this repo and I will review your code. Please consider to submit your pull request to the `dev` branch. Thank you!