Skip to content

Commit ed1c377

Browse files
authored
doc: update readme (#50)
1 parent 762ee3e commit ed1c377

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
## Rust bindings for Ada
1+
## WHATWG URL parser for Rust
22

3-
Fast [WHATWG specification](https://url.spec.whatwg.org) compliant URL parser for Rust.
3+
Fast [WHATWG URL Specification](https://url.spec.whatwg.org) compliant URL parser for Rust.
4+
Well-tested and widely used by Node.js since [Node 18](https://nodejs.org/en/blog/release/v18.17.0).
5+
6+
The Ada library passes the full range of tests from the specification, across a wide range of platforms (e.g., Windows, Linux, macOS).
7+
It fully supports the relevant [Unicode Technical Standard](https://www.unicode.org/reports/tr46/#ToUnicode).
48

59
### Usage
610

@@ -21,11 +25,14 @@ fn main() {
2125

2226
#### Features
2327

24-
**std:** Functionalities that require `std`. This feature is enabled by default, set `no-default-features` to `true` if you want `no-std`.
28+
**std:** Functionalities that require `std`.
29+
This feature is enabled by default, set `no-default-features` to `true` if you want `no-std`.
2530

26-
**serde:** Allow `Url` to work with `serde`. This feature is disabled by default. Enabling this feature without `std` would provide you only `Serialize`. Enabling this feature and `std` would provide you both `Serialize` and `Deserialize`.
31+
**serde:** Allow `Url` to work with `serde`. This feature is disabled by default. Enabling this feature without `std` would provide you only `Serialize`.
32+
Enabling this feature and `std` would provide you both `Serialize` and `Deserialize`.
2733

28-
**libcpp:** Build `ada-url` with `libc++`. This feature is disabled by default. Enabling this feature without `libc++` installed would cause compile error.
34+
**libcpp:** Build `ada-url` with `libc++`. This feature is disabled by default.
35+
Enabling this feature without `libc++` installed would cause compile error.
2936

3037
### Performance
3138

@@ -56,6 +63,7 @@ parse/url time: [6.9266 µs 6.9677 µs 7.0199 µs]
5663
| **[`Deref<Target=str>`](https://doc.rust-lang.org/std/ops/trait.Deref.html)** | Allows for `&Url` to dereference as a `&str`. Also provides a [number of string methods](https://doc.rust-lang.org/std/string/struct.String.html#deref-methods-str) |
5764
| **[`AsRef<[u8]>`](https://doc.rust-lang.org/std/convert/trait.AsRef.html), [`AsRef<str>`](https://doc.rust-lang.org/std/convert/trait.AsRef.html)** | Used to do a cheap reference-to-reference conversion. |
5865
| **[`Send`](https://doc.rust-lang.org/std/marker/trait.Send.html)** | Used to declare that the type can be transferred across thread boundaries. |
66+
| **[`Sync`](https://doc.rust-lang.org/stable/std/marker/trait.Sync.html)** | Used to declare that the type is thread-safe. |
5967

6068
### Development
6169

@@ -74,3 +82,9 @@ parse/url time: [6.9266 µs 6.9677 µs 7.0199 µs]
7482
```sh
7583
SKIP_FEATURES=serde,libcpp ./test.sh
7684
```
85+
86+
### License
87+
88+
This code is made available under the Apache License 2.0 as well as the MIT license.
89+
90+
Our tests include third-party code and data. The benchmarking code includes third-party code: it is provided for research purposes only and not part of the library.

0 commit comments

Comments
 (0)