diff --git a/README.md b/README.md index ff339c5f..835b366b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,34 @@ ## Overview -The Polkadot Contract Wizard is a smart contract creation tool that allows users to create their own smart contracts in minutes. This tool is designed to adhere to the Polkadot Standards (**PSP22**, **PSP34**, and **PSP37**) and provides useful extensions with custom logic such as Ownable, Roles, Mintable, Burnable, Timelock, and Payment Splitter. Additionally, it contains useful macros to simplify the development process such as function modifiers, storage definition, and trait definitions. With the Polkadot Contract Wizard, users can easily create their own smart contracts in just three steps: 1. Choose your contract features, 2. Deploy your smart contract and 3. Use your smart contract. +The Polkadot Contract Wizard is an advanced smart contract creation and interaction tool tailored for the Substrate ecosystems. Originally designed to simplify the process of smart contract creation, the tool adheres to key Polkadot Standards (PSP22, PSP34, and PSP37). With its user-friendly interface, it allows both beginners and experienced developers to create, deploy, modify, and now interact with smart contracts across multiple chains. + +## Key Features + +### ๐งโ๐ป Smart Contract Creation +- **Easy Creation Process**: Create your own smart contracts in minutes with a straightforward three-step process: Choose your contract features, deploy your smart contract, and use your smart contract. +- **Custom Logic Extensions**: Includes extensions such as Ownable, Roles, Mintable, Burnable, Timelock, and Payment Splitter. +- **Development Simplification**: Utilize helpful macros for function modifiers, storage definition, and trait definitions. + +### ๐งฉ Smart Contract Interaction + +#### 1. Interact with Deployed Contracts ๐ฆธ +- **Direct UI Interaction**: Manage and interact with deployed contracts directly through the wizard's interface, dynamically generated based on the contract's metadata. + +#### 2. Interaction with Custom Smart Contracts ๐ฆนโโ๏ธ +- **Custom Contract Compatibility**: Engage with any smart contract by providing its metadata, network, and address, with the UI automatically adapting for seamless interaction. + +#### 3. Shareable Contract Interaction Links ๐ +- **Collaborative Tool**: Generate and share unique links for each contract, containing all essential information for interaction, thereby promoting collaboration within the developer community. + +#### 4. Support for Multiple Chains โ๏ธ +- **Parachain Connections**: Connect to a variety of parachains in the Polkadot, Kusama networks, with the flexibility to connect to other networks via web socket. + +## Upcoming Developments + +We are continually working to expand the capabilities of the Polkadot Contract Wizard. Stay tuned for more updates and features that will enhance your experience in the world of smart contract development and interaction within the substrate ecosystems. + +> Community feedback and suggestions are invaluable to us as we strive to make this tool more efficient, user-friendly, and versatile. ## Built with @@ -45,7 +72,7 @@ To run the application it is necessary to copy the environment variables file `. 3. Run the following command to start the container (Will do a build previously in the first run): ```bash - docker-compose --env-file .docker/dev.docker.env up + docker-compose --env-file .docker/dev.docker.env up --build ``` 4. Your application should now be running on the specified port. You can access it by visiting `localhost:<EXTERNAL_PORT>` (Port 3000 by default) in your browser.