diff --git a/README.md b/README.md index 5861f49..105d175 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # url.c -This is a small library to parse and manipulate URLs in conformance to RFC 3986 and WHATWG. +This is a small library to parse and manipulate URLs in conformance to RFC 3986 and (most of) the WHATWG specification. It features * No allocations @@ -15,6 +15,4 @@ You just copy paste `url.h` and `url.c` in your source tree and compile them as Some example programs are provided in the `examples/` folder. To compile them, run `build.bat` on Windows or `build.sh` on Linux. # Testing -The parser and reference resolver is tested against the URL section of the [web platform tests](https://github.com/web-platform-tests/wpt). Note that not all tests pass. This is due to the parser not doing any normalization and not supporting more niche features such as converting `\` characters to `/` or supporting drive letters like `C:` in the URL's path. - -To run the test suite, `cd` into `tests/` and compile the test runner using `build.sh` (Linux) or `build.bat` (Windows). Then, run `./test.out` (Linux) or `./test.exe` (Windows). +The parser and reference resolver is tested against the URL section of the [web platform tests](https://github.com/web-platform-tests/wpt), which validates implementations that adhere to the WHATWG specification (what the major browsers actually do). To run the test suite, `cd` into `tests/` and compile the test runner using `build.sh` (Linux) or `build.bat` (Windows). Then, run `./test.out` (Linux) or `./test.exe` (Windows). Note that not all tests pass, which is to be expected as adherence to the WHATWG specification is a work-in-progress.