Permalink
Browse files

README and LICENSE

  • Loading branch information...
zerowidth committed Jul 4, 2011
1 parent 04cbfc2 commit dd54f8c0c5f86c6610be33face9fcda956d36606
Showing with 92 additions and 0 deletions.
  1. +19 −0 LICENSE
  2. +73 −0 README.md
View
19 LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2011 Nathan Witmer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
View
@@ -0,0 +1,73 @@
+# CamperVan, a Campfire to IRC bridge
+
+## Features
+
+CamperVan, as far as your IRC client is concerned, is just another ircd.
+
+Campfire rooms and users are mapped as IRC channels and nicks. Campfire
+messages, even custom ones such as tweets and sounds, are translated
+for an IRC client to understand.
+
+## Mappings
+
+Wherever possible, Campfire messages and IRC commands are translated
+bidirectionally. Some of the mappings are:
+
+ IRC Campfire
+ --- --------
+ #day_job "Day Job" room
+ joe_bob (nick) Joe Bob (user)
+ @admin_user (nick) An admin user
+ "joe_bob: hello" (message) "Joe Bob: hello" (message)
+ https://tweet_url Tweet message
+ /me waves *waves*
+
+ /LIST List rooms
+ /JOIN #day_job Join the "Day Job" room
+ /PART #day_job Leave the "Day Job" room
+ /WHO #day_job List users in "Day Job"
+
+ /MODE +i #day_job Lock room
+ /MODE -i #day_job Unlock room
+
+ /TOPIC #day_job new topic Change room's topic to "new topic"
+
+## Usage
+
+### Installation
+
+ gem install camper_van
+ camper_van --help
+
+### Running CamperVan
+
+ camper_van
+
+Then, from your IRC client, set up a connection to `localhost:6667`. To
+authenticate with Campfire, you must configure your connection's
+password (the IRC PASS command) to be
+
+ campfire_subdomain:api_key
+
+Connect, and `/LIST` will show you the irc channels / campfire rooms you
+have access to.
+
+## Development
+
+CamperVan uses:
+
+* ruby 1.9.2 + minitest
+* [bundler](http://gembundler.com/)
+* [eventmachine](http://rubyeventmachine.com/)
+* [firering](https://github.com/EmmanuelOga/firering)
+* [logging](https://github.com/TwP/logging)
+* [trollop](http://trollop.rubyforge.org/)
+
+## License
+
+See LICENSE for details.
+
+## Contributing
+
+Fork, patch, test, pull request.
+

0 comments on commit dd54f8c

Please sign in to comment.