Migrate the README to markdown #463
Merged
Conversation
This file contains hidden or 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
dprothero
approved these changes
Apr 18, 2019
| Install from PyPi using [pip](http://www.pip-installer.org/en/latest/), a | ||
| package manager for Python. | ||
|
|
||
| pip install twilio |
There was a problem hiding this comment.
Any reason to not format these like:
pip install twilio or
pip install twilioThere was a problem hiding this comment.
No reason. I just restored the old version of this file (and added a couple things that were in the rst variant): https://github.com/twilio/twilio-python/blob/320e3913cce3cc50694d28378d598b0444abe802/README.md
There was a problem hiding this comment.
I would say to be consistent (e.g. PHP) we should use the pretty code formatting stuff.
There was a problem hiding this comment.
Hmm, but in the preview it still looks good. (shrug)
thinkingserious
approved these changes
Apr 18, 2019
|
Don't merge yet. Some issue with sphinx doc generation referencing the rst README. |
thinkingserious
approved these changes
Apr 22, 2019
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.
PyPI guide: https://packaging.python.org/guides/making-a-pypi-friendly-readme/
Sphinx Markdown support guide: http://www.sphinx-doc.org/en/master/usage/markdown.html
Contributing to Twilio