Permalink
Browse files

Documentation updates.

  • Loading branch information...
1 parent d2be664 commit e51cc65f4f751cba60cb12d5e8ee6efec0dd3b1c @knutin committed Dec 13, 2013
Showing with 13 additions and 4 deletions.
  1. +12 −3 README.md
  2. +1 −1 src/elli_tcp.erl
View
@@ -9,7 +9,7 @@ is more important than general purpose features, then `elli` might be
for you. If you find yourself digging into the implementation of a
webserver, `elli` might be for you.
-Elli is used in production at Wooga.
+Elli is used in production at Wooga and Game Analytics.
## Features
@@ -18,7 +18,7 @@ Here's the features Elli *does* have:
* Rack-style request-response. Your handler function gets a complete
request and returns a complete response. There's no messaging, no
receiving data directly from the socket, no writing responses
- directly to the socket. It's a very simple straightforward
+ directly to the socket. It's a very simple and straightforward
API. Have a look at `src/elli_example_callback.erl` for examples.
* Middlewares allows you to add useful features like compression,
@@ -52,15 +52,24 @@ Here's the features Elli *does* have:
* Pipelining
+ * SSL using built-in Erlang/OTP ssl, nice for low volume admin
+ interfaces, etc. For high volume, you should probably go with
+ nginx, stunnel or ELB if you're on AWS.
+
+ * Implement your own connection handling, for WebSockets, streaming
+ uploads, etc. See `src/elli_example_callback_handover.erl`
+
## Extensions
+ * WebSockets: https://github.com/mmzeeman/elli_websocket
* Access log: https://github.com/wooga/elli_access_log
- * Real-time statistics dashboard: https://github.com/knutin/elli_stats
* Basic auth: https://github.com/martinrehfeld/elli_basicauth
* Static content: https://github.com/chrisavl/elli_fileserve
* "Date" header: https://github.com/knutin/elli_date
* Cookies: https://github.com/drfloob/elli_cookie
+ * Real-time statistics dashboard: https://github.com/knutin/elli_stats
+
## About
View
@@ -6,7 +6,7 @@
-export_type([socket/0]).
--type socket() :: {plain, inet:socket()} | {ssl, ssl:sslsocket()}.
+-type socket() :: {plain, inet:socket()} | {ssl, ssl:sslsocket()}.
listen(plain, Port, Opts) ->
case gen_tcp:listen(Port, Opts) of

0 comments on commit e51cc65

Please sign in to comment.