Index: CHANGELOG.md |
diff --git a/CHANGELOG.md b/CHANGELOG.md |
index d7b74b6090dcc07564201ad57d088236b2a82b10..321d799ff8ff4aaef0841b09af8d332e7870c077 100644 |
--- a/CHANGELOG.md |
+++ b/CHANGELOG.md |
@@ -1,3 +1,28 @@ |
+## 0.6.0 |
+ |
+**Breaking change:** The semantics of `Request.scriptName` and |
+[`Request.url`][url] have been overhauled, and the former has been renamed to |
+[`Request.handlerPath`][handlerPath]. `handlerPath` is now the root-relative URL |
+path to the current handler, while `url`'s path is the relative path from the |
+current handler to the requested. The new semantics are easier to describe and |
+to understand. |
+ |
+[url]: http://www.dartdocs.org/documentation/shelf/latest/index.html#shelf/shelf.Request@id_url |
+[handlerPath]: http://www.dartdocs.org/documentation/shelf/latest/index.html#shelf/shelf.Request@id_handlerPath |
+ |
+Practically speaking, the main difference is that the `/` at the beginning of |
+`url`'s path has been moved to the end of `handlerPath`. This makes `url`'s path |
+easier to parse using the `path` package. |
+ |
+[`Request.change`][change]'s handling of `handlerPath` and `url` has also |
+changed. Instead of taking both parameters separately and requiring that the |
+user manually maintain all the associated guarantees, it now takes a single |
+`path` parameter. This parameter is the relative path from the current |
+`handlerPath` to the next one, and sets both `handlerPath` and `url` on the new |
+`Request` accordingly. |
+ |
+[change]: http://www.dartdocs.org/documentation/shelf/latest/index.html#shelf/shelf.Request@id_change |
+ |
## 0.5.6 |
* Fixed `createMiddleware` to only catch errors if `errorHandler` is provided. |