From 6745cad376eb9a023410e0235009d44af672f6e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Sat, 22 Aug 2015 14:04:44 +0200 Subject: Convert CHANGELOG and README to Asciidoc Update CHANGELOG in the process. --- CHANGELOG.asciidoc | 28 ++++++++++++++++++++++++++++ CHANGELOG.md | 16 ---------------- README.asciidoc | 30 ++++++++++++++++++++++++++++++ README.md | 34 ---------------------------------- 4 files changed, 58 insertions(+), 50 deletions(-) create mode 100644 CHANGELOG.asciidoc delete mode 100644 CHANGELOG.md create mode 100644 README.asciidoc delete mode 100644 README.md diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc new file mode 100644 index 0000000..de4c68a --- /dev/null +++ b/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. diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 1429363..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -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. diff --git a/README.asciidoc b/README.asciidoc new file mode 100644 index 0000000..db0932d --- /dev/null +++ b/README.asciidoc @@ -0,0 +1,30 @@ += Ranch + +Ranch is a socket acceptor pool for TCP protocols. + +== 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 +as an application or to **embed** into your own. + +Ranch provides a **modular** design, letting you choose which transport +and protocol are going to be used for a particular listener. Listeners +accept and manage connections on one port, and include facilities to +limit the number of **concurrent** connections. Connections are sorted +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 + +* [Read the guide](doc/src/guide/book.asciidoc) +* [Check the manual](doc/src/manual/) +* Look at the examples in the `examples/` directory + +== Support + +* Official IRC Channel: #ninenines on irc.freenode.net +* [Mailing Lists](http://lists.ninenines.eu) +* [Commercial Support](http://ninenines.eu/support) diff --git a/README.md b/README.md deleted file mode 100644 index 570d27d..0000000 --- a/README.md +++ /dev/null @@ -1,34 +0,0 @@ -Ranch -===== - -Ranch is a socket acceptor pool for TCP protocols. - -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 -as an application or to **embed** into your own. - -Ranch provides a **modular** design, letting you choose which transport -and protocol are going to be used for a particular listener. Listeners -accept and manage connections on one port, and include facilities to -limit the number of **concurrent** connections. Connections are sorted -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 ---------------- - - * [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 - -Support -------- - - * Official IRC Channel: #ninenines on irc.freenode.net - * [Mailing Lists](http://lists.ninenines.eu) - * [Commercial Support](http://ninenines.eu/support) -- cgit v1.2.3