diff options
author | Richard Walters <rwalters@digitalstirling.com> | 2020-10-14 22:38:44 -0700 |
---|---|---|
committer | Richard Walters <rwalters@digitalstirling.com> | 2020-10-14 22:38:44 -0700 |
commit | 472c84a39a29bb9a2778cac67f5a9be78eca93bc (patch) | |
tree | 07526bd1be9922d39d36829dfaeacd9d645d2563 /README.md | |
parent | b4fb0021700594eafe1adc8055baf40a8ab5174e (diff) |
Preparation for publishing on crates.io
* Rename crate to "rhymuri" since "uri" is taken; FeelsBadMan
* Bump crate version to 1.0.0.
* Add categories, keywords, and repository metadata.
* Update README with links to crates.io and documentation.
* Add license reference in README.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 18 |
1 files changed, 15 insertions, 3 deletions
@@ -1,9 +1,17 @@ -# Uri +# Uri (rhymuri) -This is a library which implements [RFC +This is a library which implements [IETF RFC 3986](https://tools.ietf.org/html/rfc3986), "Uniform Resource Identifier (URI): Generic Syntax". +[![Crates.io](https://img.shields.io/crates/v/rhymuri.svg)](https://crates.io/crates/rhymuri) +[![Documentation](https://docs.rs/rhymuri/badge.svg)][dox] + +More information about the Rust implementation of this library can be found in +the [crate documentation][dox]. + +[dox]: https://docs.rs/rhymuri + A URI is a compact sequence of characters that identifies an abstract or physical resource. One common form of URI is the Uniform Resource Locator (URL), used to reference web resources: @@ -18,7 +26,7 @@ The purpose of this library is to provide a `Uri` type to represent a URI, with functions to parse URIs from their string representations, as well as assemble URIs from their various components. -This is a multi-language library. There are independent implementations here +This is a multi-language library containing independent implementations for the following programming languages: * C++ @@ -70,3 +78,7 @@ For [CMake](https://cmake.org/): cd build cmake --build . --config Release ``` + +## License + +Licensed under the [MIT license](LICENSE.txt). |