Browse Source

Add very basic readme

master
Chris Smith 12 years ago
parent
commit
bd054f1369
1 changed files with 12 additions and 0 deletions
  1. 12
    0
      README.textile

+ 12
- 0
README.textile View File

@@ -0,0 +1,12 @@
1
+h1. RestIRC
2
+
3
+h2. What is it?
4
+
5
+_RestIRC_ aims to provide a REST-ful interface to IRC. The primary use-case is
6
+to allow websites, scripts and applications to quickly and easily interact with
7
+IRC to, for example, notify certain channels about events. After that, the goal
8
+is to enable remote scripts and applications to listen to and respond to events
9
+by registering WebHooks.
10
+
11
+Ideally, it will eventually be possible to write a full IRC client on top of
12
+the API without having to interact with IRC itself directly.

Loading…
Cancel
Save