Skip to content
This repository has been archived by the owner on Dec 21, 2018. It is now read-only.

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
* adds basic project documentation to README
* adds LICENSE file
  • Loading branch information
willkg committed Jul 24, 2012
1 parent fc94a57 commit af1923d
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 1 deletion.
28 changes: 28 additions & 0 deletions LICENSE
@@ -0,0 +1,28 @@
Copyright (c) 2012, Mozilla Foundation
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3. Neither the name of Jig nor the names of its contributors may
be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

45 changes: 44 additions & 1 deletion README.mkd
@@ -1 +1,44 @@
The irc bot to got with http://github.com/rlr/standup
jumpups-irc
===========

Summary
-------

The irc bot to got with [Standup](https://github.com/rlr/standup).

* **Code:** https://github.com/mythmon/jumpups-irc
* **Issues:** https://github.com/mythmon/jumpups-irc/issues
* **License:** BSD


Install
-------

Clone the repository:

$ git clone https://github.com/mythmon/jumpups-irc
$ cd jumpups-irc

Get the dependencies:

$ npm install .


Configure
---------

Next you need to configure jumpups-irc:

$ cp config.ini.example config.ini
<edit config.ini with your favorite editor>

There are comments in the config file regarding the various
properties.


Run
---

After you've configured it, you can run it like this:

$ node jumpups-irc.js

0 comments on commit af1923d

Please sign in to comment.