docs: Update docs

docs/src/README.md

@@ -1,66 +1,147 @@
-## Foundry
+<!-- PROJECT SHIELDS -->
 
-**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
 
-Foundry consists of:
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <!-- <a href="https://github.com/mgnfy-view/safe-subscriptions">
+    <img src="assets/icon.svg" alt="Logo" width="80" height="80">
+  </a> -->
 
--   **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
--   **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
--   **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
--   **Chisel**: Fast, utilitarian, and verbose solidity REPL.
+  <h3 align="center">Safe Subscriptions</h3>
 
-## Documentation
+  <p align="center">
+    Safe subscriptions is a Gnosis Safe module that enables Safe multisigs to manage web3 subscriptions
+    <br />
+    <a href="https://github.com/mgnfy-view/safe-subscriptions/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
+    ·
+    <a href="https://github.com/mgnfy-view/safe-subscriptions/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
+  </p>
+</div>
 
-https://book.getfoundry.sh/
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+  </ol>
+</details>
 
-## Usage
+<!-- ABOUT THE PROJECT -->
 
-### Build
+## About The Project
 
-```shell
-$ forge build
-```
+Safe subscriptions is a Gnosis Safe module that enables Safe multisigs to manage web3 subscriptions. It can be deployed and attached to a Safe by mutual agreement of the multisig owners (if the threshold for the proposal passes) and can be detached pretty easily as well.
 
-### Test
+Once attached, the multisig owners can create multiple recurring or fixed duration/round subscriptions that allow the service providers to withdraw native or ERC20 tokens from the multisig based on the configured parameters. Subscriptions can be cancelled any time as well.
 
-```shell
-$ forge test
-```
+### Built With
 
-### Format
+- Solidity
+- Foundry
 
-```shell
-$ forge fmt
-```
+<!-- GETTING STARTED -->
 
-### Gas Snapshots
+## Getting Started
 
-```shell
-$ forge snapshot
-```
+### Prerequisites
 
-### Anvil
+Make sure you have git, rust, and foundry installed and configured on your system.
 
-```shell
-$ anvil
-```
+### Installation
 
-### Deploy
+Clone the repo,
 
 ```shell
-$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
+git clone https://github.com/mgnfy-view/safe-subscriptions.git
 ```
 
-### Cast
+cd into the repo, and install the necessary dependencies
 
 ```shell
-$ cast <subcommand>
+cd safe-subscriptions
+forge build
 ```
 
-### Help
+Run tests by executing
 
 ```shell
-$ forge --help
-$ anvil --help
-$ cast --help
+forge test
 ```
+
+That's it, you are good to go now!
+
+<!-- ROADMAP -->
+
+## Roadmap
+
+-   [x] Smart contract development
+-   [x] Unit tests
+-   [x] Write a good README.md
+
+See the [open issues](https://github.com/mgnfy-view/safe-subscriptions/issues) for a full list of proposed features (and known issues).
+
+<!-- CONTRIBUTING -->
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+<!-- LICENSE -->
+
+## License
+
+Distributed under the MIT License. See `LICENSE.txt` for more information.
+
+<!-- CONTACT -->
+
+## Reach Out
+
+Here's a gateway to all my socials, don't forget to hit me up!
+
+[![Linktree](https://img.shields.io/badge/linktree-1de9b6?style=for-the-badge&logo=linktree&logoColor=white)][linktree-url]
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+
+[contributors-shield]: https://img.shields.io/github/contributors/mgnfy-view/safe-subscriptions.svg?style=for-the-badge
+[contributors-url]: https://github.com/mgnfy-view/safe-subscriptions/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/mgnfy-view/safe-subscriptions.svg?style=for-the-badge
+[forks-url]: https://github.com/mgnfy-view/safe-subscriptions/network/members
+[stars-shield]: https://img.shields.io/github/stars/mgnfy-view/safe-subscriptions.svg?style=for-the-badge
+[stars-url]: https://github.com/mgnfy-view/safe-subscriptions/stargazers
+[issues-shield]: https://img.shields.io/github/issues/mgnfy-view/safe-subscriptions.svg?style=for-the-badge
+[issues-url]: https://github.com/mgnfy-view/safe-subscriptions/issues
+[license-shield]: https://img.shields.io/github/license/mgnfy-view/safe-subscriptions.svg?style=for-the-badge
+[license-url]: https://github.com/mgnfy-view/safe-subscriptions/blob/master/LICENSE.txt
+[linktree-url]: https://linktr.ee/mgnfy.view

docs/src/src/SafeSubscriptions.sol/contract.SafeSubscriptions.md

@@ -1,5 +1,5 @@
 # SafeSubscriptions
-[Git Source](https://github.com/mgnfy-view/safe-subscriptions/blob/7655498651b4e9751995b9d5f9d47397b3b97bd0/src/SafeSubscriptions.sol)
+[Git Source](https://github.com/mgnfy-view/safe-subscriptions/blob/afae2266cf372f06ed0f14e9e93730ce80fbbe96/src/SafeSubscriptions.sol)
 
 **Inherits:**
 EIP712, [ISafeSubscriptions](/src/interfaces/ISafeSubscriptions.sol/interface.ISafeSubscriptions.md)

docs/src/src/interfaces/ISafeSubscriptions.sol/interface.ISafeSubscriptions.md

@@ -1,5 +1,5 @@
 # ISafeSubscriptions
-[Git Source](https://github.com/mgnfy-view/safe-subscriptions/blob/7655498651b4e9751995b9d5f9d47397b3b97bd0/src/interfaces/ISafeSubscriptions.sol)
+[Git Source](https://github.com/mgnfy-view/safe-subscriptions/blob/afae2266cf372f06ed0f14e9e93730ce80fbbe96/src/interfaces/ISafeSubscriptions.sol)
 
 
 ## Functions