LADI
/
py-hyperlink
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Various fixes to the README 

* Link to the two RFCs
* Don't indent the code examples
* We test on Python 3.6 as well
* /s/souce/source
This commit is contained in:
Alex Chan 2017-07-08 13:49:54 +01:00
parent 529aa68743
commit 92d21cf87f
No known key found for this signature in database
GPG Key ID: 27EFD834EE46B09A
1 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -7,12 +7,16 @@
<a href="http://calver.org"><img src="https://img.shields.io/badge/calver-YY.MINOR.MICRO-22bfda.svg"></a>
Hyperlink provides a pure-Python implementation of immutable
URLs. Based on RFC 3986 and 3987, the Hyperlink URL makes working with
both URIs and IRIs easy.
URLs. Based on [RFC 3986][rfc3986] and [3987][rfc3987], the Hyperlink URL
makes working with both URIs and IRIs easy.
Hyperlink is tested against Python 2.7, 3.4, 3.5, and PyPy.
Hyperlink is tested against Python 2.7, 3.4, 3.5, 3.6, and PyPy.
Full documentation is available on [Read the Docs](http://hyperlink.readthedocs.io/en/latest/).
Full documentation is available on [Read the Docs][docs].
[rfc3986]: https://tools.ietf.org/html/rfc3986
[rfc3987]: https://tools.ietf.org/html/rfc3987
[docs]: http://hyperlink.readthedocs.io/en/latest/
## Installation
@ -20,23 +24,21 @@ Hyperlink is a pure-Python package and requires nothing but
Python. The easiest way to install is with pip:
```
pip install hyperlink
pip install hyperlink
```
Then, hyperlink away!
```python
from hyperlink import URL
from hyperlink import URL
url = URL.from_text('http://github.com/mahmoud/hyperlink?utm_souce=README')
utm_source = url.get('utm_source')
better_url = url.replace(scheme='https')
user_url = better_url.click('..')
url = URL.from_text('http://github.com/mahmoud/hyperlink?utm_source=README')
utm_source = url.get('utm_source')
better_url = url.replace(scheme='https')
user_url = better_url.click('..')
```
See the full API docs [here](https://hyperlink.readthedocs.io/en/latest/).
See the full API docs on [Read the Docs][docs].
## More information