From 174b5d01e802c6a4ff9d1467f04c5acafb916105 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Tue, 4 May 2010 16:52:10 -0700 Subject: README: avoid needless links to /Unicorn.html module It makes the HTML page too big and busy. --- README | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README b/README index 11a9a3c..975925e 100644 --- a/README +++ b/README @@ -1,6 +1,6 @@ = Unicorn: Rack HTTP server for fast clients and Unix -Unicorn is an HTTP server for Rack applications designed to only serve +\Unicorn is an HTTP server for Rack applications designed to only serve fast clients on low-latency, high-bandwidth connections and take advantage of features in Unix/Unix-like kernels. Slow clients should only be served by placing a reverse proxy capable of fully buffering @@ -14,9 +14,9 @@ both the the request and response in between Unicorn and slow clients. * Compatible with both Ruby 1.8 and 1.9. Rubinius support is in-progress. -* Process management: Unicorn will reap and restart workers that +* Process management: \Unicorn will reap and restart workers that die from broken apps. There is no need to manage multiple processes - or ports yourself. Unicorn can spawn and manage any number of + or ports yourself. \Unicorn can spawn and manage any number of worker processes you choose to scale to your backend. * Load balancing is done entirely by the operating system kernel. @@ -32,11 +32,11 @@ both the the request and response in between Unicorn and slow clients. * Builtin reopening of all log files in your application via USR1 signal. This allows logrotate to rotate files atomically and quickly via rename instead of the racy and slow copytruncate method. - Unicorn also takes steps to ensure multi-line log entries from one + \Unicorn also takes steps to ensure multi-line log entries from one request all stay within the same file. * nginx-style binary upgrades without losing connections. - You can upgrade Unicorn, your entire application, libraries + You can upgrade \Unicorn, your entire application, libraries and even your Ruby interpreter without dropping clients. * before_fork and after_fork hooks in case your application @@ -59,14 +59,14 @@ both the the request and response in between Unicorn and slow clients. == License -Unicorn is copyright 2009 by all contributors (see logs in git). +\Unicorn is copyright 2009 by all contributors (see logs in git). It is based on Mongrel and carries the same license. Mongrel is copyright 2007 Zed A. Shaw and contributors. It is licensed under the Ruby license and the GPL2. See the included LICENSE file for details. -Unicorn is 100% Free Software. +\Unicorn is 100% Free Software. == Install @@ -111,17 +111,17 @@ In RAILS_ROOT, run: unicorn_rails -Unicorn will bind to all interfaces on TCP port 8080 by default. +\Unicorn will bind to all interfaces on TCP port 8080 by default. You may use the +--listen/-l+ switch to bind to a different address:port or a UNIX socket. === Configuration File(s) -Unicorn will look for the config.ru file used by rackup in APP_ROOT. +\Unicorn will look for the config.ru file used by rackup in APP_ROOT. -For deployments, it can use a config file for Unicorn-specific options +For deployments, it can use a config file for \Unicorn-specific options specified by the +--config-file/-c+ command-line switch. See -Unicorn::Configurator for the syntax of the Unicorn-specific options. +Unicorn::Configurator for the syntax of the \Unicorn-specific options. The default settings are designed for maximum out-of-the-box compatibility with existing applications. @@ -134,7 +134,7 @@ options. There is NO WARRANTY whatsoever if anything goes wrong, but {let us know}[link:ISSUES.html] and we'll try our best to fix it. -Unicorn is designed to only serve fast clients either on the local host +\Unicorn is designed to only serve fast clients either on the local host or a fast LAN. See the PHILOSOPHY and DESIGN documents for more details regarding this. @@ -144,6 +144,6 @@ All feedback (bug reports, user/development dicussion, patches, pull requests) go to the mailing list/newsgroup. See the ISSUES document for information on the {mailing list}[mailto:mongrel-unicorn@rubyforge.org]. -For the latest on Unicorn releases, you may also finger us at +For the latest on \Unicorn releases, you may also finger us at unicorn@bogomips.org or check our NEWS page (and subscribe to our Atom feed). -- cgit v1.2.3-24-ge0c7