docs: create package docs

README.md

@@ -0,0 +1,75 @@
+<br/>
+<p align="center">
+  <a href="https://github.com/ReneJFC/conmmit">
+    <img src="https://github.com/renejfc/conmmit/assets/60465053/ba73d1b7-0027-4493-ae11-424e03e15491" alt="Conventional Commits logo" width="80" height="80">
+  </a>
+
+  <h3 align="center">CONMMIT</h3>
+
+  <p align="center">
+    A CLI that helps you create conventional commits with ease :)
+  </p>
+  <h6 align="center"><i>Name's from (CON)ventional co(MMIT)s</i></h6>
+  <p align="center">
+    <br/>
+    <a href="https://github.com/ReneJFC/conmmit/issues">report a bug</a>
+    .
+    <a href="https://github.com/ReneJFC/conmmit/issues">request a feature</a>
+  </p>
+
+  <div align="center">
+    <a href="https://www.npmjs.com/package/conmmit">
+      <img alt="NPM Downloads" src="https://img.shields.io/npm/d18m/conmmit?style=for-the-badge&logo=bun">
+    </a>
+      <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/renejfc/conmmit?style=for-the-badge&logo=github&color=e3b341">
+  </div>
+</p>
+
+https://github.com/renejfc/conmmit/assets/60465053/a6eae809-c40e-4959-98c9-8390c05a2d1c
+
+## Usage
+
+> [!NOTE]  
+> This package is bun-only, so you'll need [bun](https://bun.sh/).
+
+You can either execute it on the fly with
+
+```
+bunx conmmit
+```
+
+or install it globally using
+
+```
+bun add -g conmmit
+```
+
+and then use it any time with
+
+```
+conmmit
+```
+
+---
+
+Here's the list of the available flags
+
+| Flag      | Alias | Description                   |
+| :-------- | :---- | :---------------------------- |
+| --add     | -a    | Choose which files to add     |
+| --add-all | -A    | Add all changes to the commit |
+
+## Demos
+
+- `conmmit --add` | `conmmit -a`
+  - <details>
+      <summary>👀</summary>
+      
+      https://github.com/renejfc/conmmit/assets/60465053/f0289546-0a61-4cb6-9e38-faec323495ba
+    </details>
+- `conmmit --add-all` | `conmmit -A`
+  - <details>
+      <summary>👀</summary>
+      
+      https://github.com/renejfc/conmmit/assets/60465053/fbe1caa3-2b2b-4168-9c8b-6d4c7c0ad605
+    </details>