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.

Sign up for GitHub

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

Jump to bottom

Improve readme file #36

Closed
2 of 3 tasks
poush opened this issue Oct 12, 2018 · 2 comments
Closed
2 of 3 tasks

Improve readme file #36

poush opened this issue Oct 12, 2018 · 2 comments
Labels
good first issue Good for newcomers Hacktoberfest

Comments

@poush
Copy link
Owner

poush commented Oct 12, 2018 •
edited
Loading

There are a few improvements I can propose, feel free to suggest yours.

  • Add features mentioned on first two lines in a proper format like in the numbered list.~
  • Add a GIF (lightweight) instead of the static image, which shows how to use it. (Thanks @rouzbehhz for using such examples in PRs)
  • In the contribution section, add two subsections. First is to contribute by code, second is to contribute by testing on your system and reporting any bugs over issue channel.

Feel free to pick any of them. Do mention if you start and please do suggest yours here.
@pushpinder107 pushpinder107 mentioned this issue Oct 12, 2018
Merged
@pushpinder107
Copy link
Contributor

Raised #37

@poush
Copy link
Owner Author

poush commented Oct 13, 2018

Removing 3rd option for now and creating new issue for second option.

@poush poush closed this as completed Oct 13, 2018
This was referenced Oct 18, 2018
Open
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@poush @pushpinder107