Skip to content

Commit

Permalink
feat: update README with newer class names with slightly better examp…
Browse files Browse the repository at this point in the history
…les.
  • Loading branch information
joshorr committed Dec 19, 2023
1 parent 9097016 commit 4f9993f
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@

## Documentation

This is pre-release Alpha software, based on another code base and
the needed changes to make a final release version are not yet
completed.
A high-level `Url` class to make parsing, looking at and manipulating
urls much easier.

Also allows for easily composable urls.

Everything is subject to change!

Expand All @@ -32,6 +33,6 @@ url = Url("http://www.google.com/some/path")
assert url.host == "www.google.com"

url.host = "apple.com"
assert url.url() == "http://appe.com/some/path"
assert str(url) == "http://apple.com/some/path"
```

0 comments on commit 4f9993f

Please sign in to comment.