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

Edit README.md to align with standards #4

Open
msradam opened this issue Oct 31, 2019 · 0 comments
Open

Edit README.md to align with standards #4

msradam opened this issue Oct 31, 2019 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest

Comments

@msradam
Copy link
Collaborator

msradam commented Oct 31, 2019

Issue

The current README is sufficient to explain the functionality of the service but may be cleaned up to better align with the formatting used in other Buildly marketplace services e.g. https://github.com/Buildly-Marketplace/crm_service.

Solution

Adjust the Markdown formatting in the README and rewrite to lay out clear instructions - this may be modified depending on the addition of new features such as containerization and continuous integration.
@msradam msradam added documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest labels Oct 31, 2019
@weslley75 weslley75 mentioned this issue Nov 1, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@msradam