Skip to content

Commit 0cf4bd5

Browse files
Update README and bump the version (#115)
* Update README * update * Update README * Update README * Update package version
1 parent ce1323a commit 0cf4bd5

File tree

2 files changed

+29
-16
lines changed

2 files changed

+29
-16
lines changed

README.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
## ERC721M
1+
# ERC721M
2+
3+
[![NPM][npm-shield]][npm-url]
4+
[![CI][ci-shield]][ci-url]
5+
[![MIT License][license-shield]][license-url]
26

37
ERC721M is a EVM minting protocol that enables the multi stage minting, per stage WL management, per stage supply limit, and crossmint support.
48

@@ -8,43 +12,42 @@ We'd like to introduce the standard of "minting stages". At each stage, the crea
812

913
- per-stage price
1014
- per-stage walletLimit
11-
- per-stage merkleRoot
15+
- per-stage merkleRoot(whitelist)
1216
- per-stage maxStageSupply
1317

1418
The composability of the stages is generic enough to enable flexible and complicated EVM minting contracts.
1519

16-
![](https://bafkreid7sfgi5tycdvbdtobl3mqnwjlrlawdgioaj6vxvtcmmda74doh7q.ipfs.nftstorage.link/)
17-
18-
19-
## Build status
20-
![github ci status](https://github.com/magiceden-oss/erc721m/actions/workflows/ci.yml/badge.svg?branch=main)
21-
22-
![npm](https://img.shields.io/npm/v/@magiceden-oss/erc721m?color=green)
20+
<p align="center">
21+
<img src="https://bafkreid7sfgi5tycdvbdtobl3mqnwjlrlawdgioaj6vxvtcmmda74doh7q.ipfs.nftstorage.link/" width="50%" >
22+
</p>
2323

2424

25-
## Tech/framework used
25+
## Tech/ Framework
2626

2727
<b>Built with</b>
28-
- [hardhat](https://hardhat.org)
29-
- [ERC721A](https://github.com/chiru-labs/ERC721A), ERC721M is based on the popular ERC721A contract.
28+
- [Hardhat](https://hardhat.org)
29+
- [ERC721A](https://github.com/chiru-labs/ERC721A) by Azuki. Fully compliant implementation of IERC721 with significant gas savings for batch minting.
30+
- [ERC721C](https://github.com/limitbreakinc/creator-token-standards) by LimitBreak. Extends ERC721 and add creator-definable transfer security profiles that are the foundation for enforceable, programmable royalties.
3031

3132
## Features
3233

3334
- Minting Stages
3435
- Permenent BaseURI Support
3536
- Non-incresing Max Total Supply Support
36-
- Per-stage WL Merkle Tree
37+
- Per-stage whitelist Merkle Tree
3738
- Per-stage Max Supply
3839
- Global and Per-stage Limit
40+
- Crossmint support
3941
- Native TypeScript and Typechain-Types Support
4042

4143
## Contracts
4244
| Contract | Description |
4345
|-------------------------|---------------------------------------------------------------------------------------|
44-
| ERC721M | The basic minting contract |
46+
| ERC721M | The basic minting contract based on ERC721A. |
47+
| ERC721CM | The basic minting contract based on ERC721C and ERC721M. |
48+
| ERC721CMRoyalties | Based on ERC721CM, implementing ERC2981 for on-chain royalty. |
4549
| ERC721MLite | The lite version of ERC721M |
4650
| ERC721MOperatorFilterer | ERC721M with OpenSea Operator Filterer |
47-
| ERC721MOnft | ERC721M with LayerZero bridging. The contract is on beta. Use at your own risk. |
4851
| BucketAuction | Bucket auction style minting contract. The contract is on beta. Use at your own risk. |
4952
| DutchAuction | Dutch auction style minting contract. The contract is on beta. Use at your own risk. |
5053

@@ -102,3 +105,13 @@ We are targeting 100% lines coverage.
102105
## License
103106

104107
MIT © [MagicEden Open Source](https://github.com/magiceden-oss)
108+
109+
110+
<!-- MARKDOWN LINKS & IMAGES -->
111+
112+
[ci-shield]: https://img.shields.io/github/actions/workflow/status/magiceden-oss/erc721m/ci.yml?label=build&style=for-the-badge&branch=main
113+
[ci-url]: https://github.com/magiceden-oss/erc721m/actions/workflows/run_tests.yml
114+
[npm-shield]: https://img.shields.io/npm/v/@magiceden-oss/erc721m.svg?style=for-the-badge
115+
[npm-url]: https://www.npmjs.com/package/@magiceden-oss/erc721m
116+
[license-shield]: https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge
117+
[license-url]: https://github.com/magiceden-oss/erc721m/blob/main/LICENSE.txt

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@magiceden-oss/erc721m",
3-
"version": "0.0.11",
3+
"version": "0.1.0",
44
"description": "erc721m contract for Solidity",
55
"files": [
66
"/contracts/**/*.sol",

0 commit comments

Comments
 (0)