:wave: @StylesLyle, Mona has created a README and needs your help making it great. :sparkles:
Why you need a README.md
The README.md is the landing page for your project. It helps people understand, at a glance, whether your project is something that will be useful to them.
README.md files typically include information on:
What the project does
The features and benefits of the project
How users can get started with the project
Where users can get help with your project
Who maintains and contributes to the project
Check it out
Mona's README.md is missing some of the information above. Will you help Mona by replacing the placeholder text?
:keyboard: Activity: Editing the README.md
Access the Files changed tab in this pull request.
Click the icon on the right of the file to edit the README.md.
Find the two placeholder texts labeled DESCRIPTION PLACEHOLDER and FEATURES PLACEHOLDER. Replace them with some bulleted information that may be helpful to new users.
After editing the README.md file, scroll down and click the Commit changes button.
Step 2: Edit the README.md
:wave: @StylesLyle, Mona has created a README and needs your help making it great. :sparkles:
Why you need a README.md
The
README.md
is the landing page for your project. It helps people understand, at a glance, whether your project is something that will be useful to them.README.md
files typically include information on:Check it out
Mona's
README.md
is missing some of the information above. Will you help Mona by replacing the placeholder text?:keyboard: Activity: Editing the README.md
README.md
.README.md
file, scroll down and click the Commit changes button.Watch below for my response.