Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Adding a readme file.

  • Loading branch information...
commit e042bf32dc68d3fcb6c3aa435f1228f1a6b06ccf 1 parent 1624e0b
@archaelus authored
Showing with 27 additions and 0 deletions.
  1. +27 −0 README.rst
View
27 README.rst
@@ -0,0 +1,27 @@
+=====================================================
+ErlIRC - An Internet Relay Chat framework for Erlang
+=====================================================
+
+ErlIRC is a framework for writing IRC clients, servers, proxies and
+bots in Erlang.
+
+Example Use
+===========
+
+Run ``erl -name erlirc -pa ebin`` and run the following commands::
+
+ (erlirc@bete.ran)1> irc_app:start().
+ <SASL reports snipped>
+ (erlirc@bete.ran)2> {ok, Server} = irc_sup:start_server("localnet","localhost").
+ <SASL reports snipped>
+ {ok,<0.54.0>}
+ (erlirc@bete.ran)3> irc_server:listen(Server, 16667).
+ {ok,<0.56.0>}
+
+Then from another bash console, telnet to the new server and send it
+IRC commands::
+
+ telnet localhost 16667
+ NICK test
+ USER test test localhost :Test User
+ JOIN :#test
Please sign in to comment.
Something went wrong with that request. Please try again.