summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Schoenfelder <paulschoenfelder@gmail.com>2013-12-05 10:31:28 -0600
committerPaul Schoenfelder <paulschoenfelder@gmail.com>2013-12-05 10:31:28 -0600
commita1fa95d8b039e98dbfd2b8f893633c34fada784b (patch)
treee8c4e5a25737a944a33066522e9bc6444d8c1923 /README.md
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b6a92d9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# exirc
+
+ExIRC is a IRC client library for Elixir projects. It aims to have a clear, well
+documented API, with the minimal amount of code necessary to allow you to connect and
+communicate with IRC servers effectively. It aims to implement the full RFC2812 protocol,
+and relevant parts of RFC1459.
+
+# Why?
+
+I had need of this in another project of mine, and found that there were no good libraries available,
+documentation was always missing, it wasn't clear how to use, and in general were not easy to work
+with.
+
+# Status
+
+Just getting started, but I have most everything I need. I plan to have the basics implemented sometime
+in the next week.
+