feat: adding the documentation and a example .env

.env.example

@@ -1,18 +1,8 @@
-# Profile
-export FOUNDRY_PROFILE="default"
+RPC_URL=
+PRIVATE_KEY=
+ETHERSCAN_API_KEY=""
 
-export API_KEY_INFURA="YOUR_API_KEY_INFURA"
-export FOUNDRY_PROFILE="default"
+## OSx Protocol
+PLUGIN_REPO_FACTORY=
+DAO_FACTORY=
 
-# Forking
-export FORKING_NETWORK="mainnet"
-export FORK_BLOCK=18335949
-
-# DAOFactory, RepoFactory
-export MAINNET=0xA03C2182af8eC460D498108C92E8638a580b94d4,0x96E54098317631641703404C06A5afAD89da7373
-export GOERLI=0x1E4350A3c9aFbDbd70FA30B9B2350B9E8182449a,0x477EB3b39C92c38B43778266b09471285e0F7808
-export SEPOLIA=0x7a62da7B56fB3bfCdF70E900787010Bc4c9Ca42e,0x07f49c49Ce2A99CF7C28F66673d406386BDD8Ff4
-export POLYGON=0x51Ead12DEcD31ea75e1046EdFAda14dd639789b8,0x6E924eA5864044D8642385683fFA5AD42FB687f2
-export MUMBAI=0xc715336B5E7F10294F36CA09f19A0493070E2eFB,0x4E7c97ab08c046A8e43571f9839d768ae84492e4
-export BASE_MAINNET=0x1B6632D1357D26055D6452E3b3BEBd1c1d982e86,0xE47C0B1Ea698F2914b6CC218cdC3A5Ca4FAcff18
-export BASE_GOERLI=0x3E773BCb6a8C5ED2f23BF167284DF45D9A550fF6,0x1B6632D1357D26055D6452E3b3BEBd1c1d982e86

README.md

@@ -1,5 +1,47 @@
-# 🚧 UNDER CONSTRUCTION 🚧
+Aragon OSx Plugin Foundry Template 🚀
+Welcome to the Solidity Foundry template for building plugins for Aragon OSx! This template is designed to help developers quickly set up and start creating powerful decentralized autonomous organization (DAO) plugins using Solidity and Foundry.
 
-## License
+Features ✨
+Pre-configured Foundry Environment: Set up with all necessary dependencies and configurations for Aragon OSx.
+Sample Contracts: Example plugins to demonstrate integration and usage.
+Comprehensive Testing: Pre-written tests to ensure your plugins work as expected.
+Prerequisites 📋
+Node.js
+Foundry
+Git
+Getting Started 🏁
+To get started, clone this repository and install the required dependencies:
 
+bash
+Copy code
+git clone https://github.com/aragon/osx-plugin-template-foundry
+cd osx-plugin-template-foundry
+foundryup # Install or update Foundry
+forge install # Install project dependencies
+Usage 🛠
+Building a Plugin
+Create your plugin contract in the src directory. A simple plugin template is provided as MyPlugin.sol.
+
+Testing
+Run tests to ensure your plugins are working correctly:
+
+``` bash
+forge test
+```
+
+Deployment
+Deploy your plugin to a network:
+```bash
+source .env
+forge script script/Deploy.s.sol:Deploy --broadcast --rpc-url <RPC_URL> 
+```
+Contributing 🤝
+Contributions are welcome! Please read our contributing guidelines to get started.
+
+License 📄
 This project is licensed under AGPL-3.0-or-later.
+
+Support 💬
+For support, join our Discord server or open an issue in the repository.
+
+