Update README.rst #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Hi, I edited your README. Nice approach to keep it super-minimal! However, I wonder if you want to add contributor guidelines (separate file or short blurb), some notes on how/where it's currently being used, and any other install/run/config instructions that might help reduce friction even further. A note on how this project is similar/different from anything else out there would also be a nice insight. Also, do you want to add any features or other bells/whistles? You could put that in the README like a bullet point "project map"; 2-3 items = enough. Check out the templates I made for Zalando to see if you get any other ideas: -- product template: https://github.com/zalando/zalando-howto-open-source/blob/master/producttemplate.md -- README template https://github.com/zalando/zalando-howto-open-source/blob/master/README.md Thanks for submitting your link!
sils
reviewed
Apr 29, 2017
README.rst
Outdated
| @@ -1,14 +1,13 @@ | |||
| $$$ | |||
| === | |||
|
|
|||
| Converts amounts of any (a lot!) currency to dollars. | |||
| Use this Python library to convert amounts of nearly any currency into dollars. | |||
|
Hey, thanks for your ideas, looks good. This project is actually feature complete. It's minimal and serves its one purpose which is usually done in a less perfect way by people copying stuff from SO responses, just including the lib will do the job better and faster. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi, I edited your README. Nice approach to keep it super-minimal! However, I wonder if you want to add contributor guidelines (separate file or short blurb), some notes on how/where it's currently being used, and any other install/run/config instructions that might help reduce friction even further. A note on how this project is similar/different from anything else out there would also be a nice insight.
Also, do you want to add any features or other bells/whistles? You could put that in the README like a bullet point "project map"; 2-3 items = enough.
Check out the templates I made for Zalando to see if you get any other ideas:
-- product template: https://github.com/zalando/zalando-howto-open-source/blob/master/producttemplate.md
-- README template https://github.com/zalando/zalando-howto-open-source/blob/master/README.md
Thanks for submitting your link!