Skip to content

Commit c56529b

Browse files
committed
Update README
1 parent 6495e45 commit c56529b

File tree

1 file changed

+37
-9
lines changed

1 file changed

+37
-9
lines changed

README.md

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,48 @@
11
# Meta Contract
2+
A meta contract is a powerful framework for smart contract development, designed to enhance developer productivity and contract maintainability. Built on the principles of the *ERC-7546: UCS* (Upgradeable Clone Standard), this ***mc*** library provides a robust architecture for creating and managing upgradeable smart contracts.
23

3-
***Meta Contract*** is a framework for smart contract development, with its architecture based on *ERC-7546: UCS*.
4-
4+
## Features
5+
- **Upgradeable Contracts**: Create smart contracts that can be easily upgraded, allowing for continuous improvement and bug fixes without contract migration.
6+
- **Modular Design**: A meta contract promotes a modular approach to contract development, enabling code reuse and reducing complexity.
7+
- **Standard Functions**: Utilize a rich library of standard functions to streamline contract development and ensure consistency across your projects.
8+
- **Development Kit**: Leverage the mc's Development Kit (DevKit) to simplify contract deployment, testing, and interaction.
9+
- **Comprehensive Documentation**: Benefit from extensive documentation and guides to help you get started and make the most of mc's features.
510

611
## Getting Started
7-
### Prerequisite
8-
- `foundry`
12+
### Prerequisites
13+
To use mc, you need to have the following software installed:
14+
- [Foundry](https://github.com/foundry-rs/foundry) - a blazing fast, portable and modular toolkit for Ethereum application development.
15+
16+
### Installation
17+
The mc can be installed using Foundry's `forge` command with useful template:
18+
19+
```sh
20+
forge init <Your Project Name> -t metacontract/template
21+
```
922

10-
### Install
11-
It can be installed from `metacontract/mc`.
23+
You can also install only this repository at your project root using:
1224
```sh
1325
forge install metacontract/mc
1426
```
1527

16-
## Document
17-
The [MC Book](https://mc-book.ecdysis.xyz/) serves as a comprehensive guide for developing with the meta contract and is available on github at `metacontract/book`.
28+
## Documentation
29+
The [MC Book](https://mc-book.ecdysis.xyz/) serves as a comprehensive guide for developing with the meta contract. It covers a wide range of topics, including:
30+
- Architecture overview
31+
- Setting up your development environment
32+
- Creating and deploying upgradeable contracts
33+
- Using standard functions and libraries
34+
- Testing and debugging your contracts
35+
- Best practices and guidelines
36+
You can find the source code for the MC Book on GitHub at [metacontract/book](https://github.com/metacontract/book).
1837

1938
## Contributing
20-
Please check out the [Contributing Guide](./CONTRIBUTING.md).
39+
We welcome contributions from the community! If you'd like to contribute to mc, please check out our [Contributing Guide](./CONTRIBUTING.md) for detailed instructions on how to:
40+
- Report issues and bugs
41+
- Submit feature requests
42+
- Create pull requests
43+
- Follow our coding style and guidelines
44+
- Participate in discussions and decision-making
45+
We appreciate your help in making mc even better!
46+
47+
## License
48+
This mc is released under the [MIT License](./LICENSE).

0 commit comments

Comments
 (0)