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 documentation for this code #3

Open
abskrj opened this issue Oct 18, 2019 · 3 comments
Open

Add documentation for this code #3

abskrj opened this issue Oct 18, 2019 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest For Hacktoberfest event.

Comments

@abskrj
Copy link
Owner

abskrj commented Oct 18, 2019

Add documentation on :

  • How the code works.
  • How it is useful.
  • Requirements.
@abskrj abskrj added documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest For Hacktoberfest event. labels Oct 18, 2019
@abskrj abskrj closed this as completed in f135ff2 Oct 19, 2019
abskrj added a commit that referenced this issue Oct 19, 2019
@abskrj abskrj reopened this Oct 19, 2019
@abskrj
Copy link
Owner Author

abskrj commented Oct 19, 2019

Update the readme.md file.
Make it easy for beginners to contribute.

@xandmaga
Copy link
Contributor

Hi @abhishekraj272 ,
I'll be working on this issue.

@abskrj abskrj assigned abskrj and xandmaga and unassigned abskrj Oct 19, 2019
@scottydocs
Copy link

Hi @abhishekraj272 happy to help tidy up the readme and fix some typos I've spotted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest For Hacktoberfest event.
Projects
None yet
Development

No branches or pull requests

3 participants