Add README.md with Beginner's Guide for Using OpenZeppelin Contracts #5409
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This pull request introduces a new README.md file designed to help beginners get started with using OpenZeppelin contracts, such as ERC20 and ERC721. The guide covers setting up the development environment, creating and deploying ERC20 and ERC721 tokens, and provides additional resources for further learning.
Changes Included:
Added README.md file with the following sections:
Prerequisites: Required tools and versions.
Setting Up Your Development Environment: Instructions for initializing a new project, installing dependencies, and setting up Truffle or Hardhat.
Using OpenZeppelin Contracts: Step-by-step guides for creating and deploying ERC20 and ERC721 tokens.
Additional Resources: Links to documentation and community resources.
Motivation and Context
This addition aims to lower the entry barrier for new developers interested in using OpenZeppelin contracts by providing a clear and concise tutorial. It ensures that developers have a go-to reference for setting up their projects and understanding the basics of creating and deploying ERC20 and ERC721 tokens.
How Has This Been Tested?
The guide has been reviewed for accuracy and completeness.
Sample projects following the instructions have been successfully created and deployed using both Truffle and Hardhat.
Screenshots (if appropriate)
N/A
Types of Changes
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Checklist
My code follows the code style of this project.
I have performed a self-review of my own code.
I have documented my changes where applicable.
My changes generate no new warnings.
I have added tests to cover my changes.
All new and existing tests passed.
Additional Notes
N/A