Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README.md with Beginner's Guide for Using OpenZeppelin Contracts #5409

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

Swatantra-66
Copy link

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

Copy link

changeset-bot bot commented Dec 28, 2024

⚠️ No Changeset found

Latest commit: 7bf8670

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant