Skip to content

Commit 18c88b2

Browse files
committed
[README update] Move the version 2 para as ...
... release notes at the end of the file
1 parent 333bcdb commit 18c88b2

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

+17-16
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,6 @@
99
**Go-Json-Rest** is a thin layer on top of `net/http` that helps building RESTful JSON APIs easily. It provides fast URL routing using a Trie based implementation, helpers to deal with JSON requests and responses, and middlewares for additional functionalities like CORS, Auth, Gzip ...
1010

1111

12-
## What's new in version 2
13-
14-
* Middlewares, the notion of middleware is now formally defined. They can be setup as global pre-routing Middlewares wrapping all the endpoints, or on a per endpoint basis.
15-
In fact the internal code of **go-json-rest** is itself implemented with Middlewares, they are just hidden behind configuration boolean flags to make these very common options even easier to use.
16-
17-
* A new ResponseWriter. This is now an interface, and allows Middlewares to wrap the writer. The provided writer implements, in addition of *rest.ResponseWriter*, *http.Flusher*, *http.CloseNotifier*, *http.Hijacker*, and *http.ResponseWriter*. A lot more Go-ish, and very similar to `net/http`.
18-
19-
* The AuthBasic and CORS Middlewares have been added. More to come in the future.
20-
21-
* Faster, more tasks are performed at init time, and less for each request.
22-
23-
* New documentation, with more examples.
24-
25-
* A lot of other small improvements, See the [Migration guide to v2](#migration-guide-from-v1-to-v2)
26-
27-
2812
## Table of content
2913

3014
- [Features](#features)
@@ -54,6 +38,7 @@ In fact the internal code of **go-json-rest** is itself implemented with Middlew
5438
- [CORS Custom](#cors-custom)
5539
- [External Documentation](#external-documentation)
5640
- [Options](#options)
41+
- [Version 2 release notes](#version-2-release-notes)
5742
- [Migration guide from v1 to v2](#migration-guide-from-v1-to-v2)
5843
- [Thanks](#thanks)
5944

@@ -1595,6 +1580,22 @@ Things to enable in development:
15951580
- Error stack trace in the response body (default: disabled)
15961581

15971582

1583+
## Version 2 release notes
1584+
1585+
* Middlewares, the notion of middleware is now formally defined. They can be setup as global pre-routing Middlewares wrapping all the endpoints, or on a per endpoint basis.
1586+
In fact the internal code of **go-json-rest** is itself implemented with Middlewares, they are just hidden behind configuration boolean flags to make these very common options even easier to use.
1587+
1588+
* A new ResponseWriter. This is now an interface, and allows Middlewares to wrap the writer. The provided writer implements, in addition of *rest.ResponseWriter*, *http.Flusher*, *http.CloseNotifier*, *http.Hijacker*, and *http.ResponseWriter*. A lot more Go-ish, and very similar to `net/http`.
1589+
1590+
* The AuthBasic and CORS Middlewares have been added. More to come in the future.
1591+
1592+
* Faster, more tasks are performed at init time, and less for each request.
1593+
1594+
* New documentation, with more examples.
1595+
1596+
* A lot of other small improvements, See the [Migration guide to v2](#migration-guide-from-v1-to-v2)
1597+
1598+
15981599
## Migration guide from v1 to v2
15991600

16001601
**Go-Json-Rest** follows [Semver](http://semver.org/) and a few breaking changes have been introduced with the v2.

0 commit comments

Comments
 (0)