Browse Source

Convert CHANGELOG and README to Asciidoc

Update CHANGELOG in the process.
Loïc Hoguin 9 years ago
parent
commit
6745cad376
3 changed files with 38 additions and 30 deletions
  1. 28 0
      CHANGELOG.asciidoc
  2. 0 16
      CHANGELOG.md
  3. 10 14
      README.asciidoc

+ 28 - 0
CHANGELOG.asciidoc

@@ -0,0 +1,28 @@
+= CHANGELOG
+
+== 1.2.0
+
+
+* Allow the supervised process and the process owning the socket to be different
+* Add many transport options (please refer to the documentation)
+* Don't pass Ranch-specific options down to transports
+** Should make Dialyzer happy in user projects.
+** New types ranch:opt(), ranch_tcp:opt(), ranch_ssl:ssl_opt() and ranch_ssl:opt()
+* Fix crash when filtering unknown options out
+* Print a warning for each option filtered out
+* Handle Transport:controlling_socket/2 errors and close the socket
+* Handle Protocol:start_link/4 crashes to avoid killing all active connections
+* Use Asciidoc for documentation.
+* Test Ranch across 14 Erlang versions on CircleCI.
+* Improve and document test suites with recent ct_helper improvements.
+* Fix a number of intermittent test issues.
+
+== 1.1.0
+
+* Add Transport:secure/0
+* Add SSL partial_chain option
+* Stop reporting errors on {error, closed} in accept_ack
+
+== 1.0.0
+
+* Initial release.

+ 0 - 16
CHANGELOG.md

@@ -1,16 +0,0 @@
-CHANGELOG
-=========
-
-1.1.0
------
-
- *  Add Transport:secure/0
-
- *  Add SSL partial_chain option
-
- *  Stop reporting errors on {error, closed} in accept_ack
-
-1.0.0
------
-
- *  Initial release.

+ 10 - 14
README.md → README.asciidoc

@@ -1,10 +1,8 @@
-Ranch
-=====
+= Ranch
 
 Ranch is a socket acceptor pool for TCP protocols.
 
-Goals
------
+== Goals
 
 Ranch aims to provide everything you need to accept TCP connections with
 a **small** code base and **low latency** while being easy to use directly
@@ -19,16 +17,14 @@ into **pools**, each pool having a different configurable limit.
 Ranch also allows you to **upgrade** the acceptor pool without having
 to close any of the currently opened sockets.
 
-Getting started
----------------
+== Getting started
 
- *  [Read the guide](http://ninenines.eu/docs/en/ranch/HEAD/guide)
- *  [Check the manual](http://ninenines.eu/docs/en/ranch/HEAD/manual)
- *  Look at the examples in the `examples/` directory
+* [Read the guide](doc/src/guide/book.asciidoc)
+* [Check the manual](doc/src/manual/)
+* Look at the examples in the `examples/` directory
 
-Support
--------
+== Support
 
- *  Official IRC Channel: #ninenines on irc.freenode.net
- *  [Mailing Lists](http://lists.ninenines.eu)
- *  [Commercial Support](http://ninenines.eu/support)
+* Official IRC Channel: #ninenines on irc.freenode.net
+* [Mailing Lists](http://lists.ninenines.eu)
+* [Commercial Support](http://ninenines.eu/support)