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

Update project's README.md file #29

Closed
AmmarHumackicSQA opened this issue Dec 22, 2021 · 0 comments · Fixed by #161 or #160
Closed

Update project's README.md file #29

AmmarHumackicSQA opened this issue Dec 22, 2021 · 0 comments · Fixed by #161 or #160
Labels
documentation Improvements or additions to documentation

Comments

@AmmarHumackicSQA
Copy link
Contributor

AmmarHumackicSQA commented Dec 22, 2021

Final update to README.md file should contain:

  • introduction with a summary paragraph that describes the project at a high level

  • simple installation and usage instructions

  • a preview of project features with a demo GIF or screenshots

  • a list of the functions that will be included in the package (this should be a 1-2 sentence description for each function)

  • added license (a short description of the license)

@AmmarHumackicSQA AmmarHumackicSQA added the documentation Improvements or additions to documentation label Dec 22, 2021
@GentBinakuSQA GentBinakuSQA reopened this Jan 6, 2022
@AmmarHumackicSQA AmmarHumackicSQA added the change-request A request to change an existing component or feature label Jan 25, 2022
@AmmarHumackicSQA AmmarHumackicSQA removed the change-request A request to change an existing component or feature label Jan 26, 2022
This was linked to pull requests Feb 24, 2022
@lewis-sqa lewis-sqa removed a link to a pull request Feb 24, 2022
@lewis-sqa lewis-sqa linked a pull request Feb 24, 2022 that will close this issue
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants