Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 65 lines (41 sloc) 2.154 kB
2d331f4 @holman very slightly improve the README
holman authored
1 # Hubot
b253e94 @atmos fuck a color history
atmos authored
2
14d14ca Update documentation for v2.0.0
Tom Bell authored
3 This is a version of GitHub's Campfire bot, hubot. He's pretty cool.
b253e94 @atmos fuck a color history
atmos authored
4
c479064 @tombell Update the main README file to be more friendly
tombell authored
5 **You'll probably never have to hack on this repo directly.**
7aa67ca Update README with v2.0.0 intentions
Tom Bell authored
6
c479064 @tombell Update the main README file to be more friendly
tombell authored
7 Instead this repo provides a library that's distributed by `npm` that you
8 simply require in your project. Follow the instructions below and get your own
9 hubot ready to deploy.
b253e94 @atmos fuck a color history
atmos authored
10
c479064 @tombell Update the main README file to be more friendly
tombell authored
11 ## Getting your own
d12c3a1 @kneath This is what you'll need to get him up and running.
kneath authored
12
c479064 @tombell Update the main README file to be more friendly
tombell authored
13 Make sure you have [node.js][nodejs] and [npm][npmjs] installed.
b253e94 @atmos fuck a color history
atmos authored
14
c479064 @tombell Update the main README file to be more friendly
tombell authored
15 Download the [latest version of hubot][hubot-latest].
b253e94 @atmos fuck a color history
atmos authored
16
c479064 @tombell Update the main README file to be more friendly
tombell authored
17 Then follow the instructions in the [README][readme] in the extracted `hubot`
18 directory.
dd2b6b3 Update README with creating an adapter
Tom Bell authored
19
c479064 @tombell Update the main README file to be more friendly
tombell authored
20 [nodejs]: http://nodejs.org
21 [npmjs]: http://npmjs.org
22 [hubot-latest]: https://github.com/github/hubot/downloads
23 [readme]: https://github.com/github/hubot/blob/master/src/templates/README.md
43b5890 Add details about log.js to README
Tom Bell authored
24
c479064 @tombell Update the main README file to be more friendly
tombell authored
25 ## Adapters
dd2b6b3 Update README with creating an adapter
Tom Bell authored
26
c479064 @tombell Update the main README file to be more friendly
tombell authored
27 Adapters are the interface to the service you want your hubot to run on. This
28 can be something like Campfire or IRC. There are a number of third party
29 adapters that the community have contributed. Check the
30 [hubot wiki][hubot-wiki] for the available ones and how to create your own.
e291d86 Update README to explain new third-party adapters
Tom Bell authored
31
14d14ca Update documentation for v2.0.0
Tom Bell authored
32 Please submit issues and pull requests for third party adapters to the adapter
33 repo not this repo unless it's the Campfire or Shell adapter.
34
c479064 @tombell Update the main README file to be more friendly
tombell authored
35 [hubot-wiki]: https://github.com/github/hubot/wiki
36 [third-party-adapters]: https://github.com/github/hubot/tree/master/src/adapters/third-party
37 [split-subpath]: http://help.github.com/split-a-subpath-into-a-new-repo/
38 [logjs]: https://github.com/visionmedia/log.js
39
40 ## hubot-scripts
b253e94 @atmos fuck a color history
atmos authored
41
6f88197 Update README with detailed explaination
Tom Bell authored
42 Hubot ships with a number of default scripts, but there's a growing number of
c479064 @tombell Update the main README file to be more friendly
tombell authored
43 extras in the [hubot-scripts][hubot-scripts] repository. `hubot-scripts` is a
44 way to share scripts with the entire community.
45
46 Check out the [README][hubot-scripts-readme] for more help on installing
47 individual scripts.
6f88197 Update README with detailed explaination
Tom Bell authored
48
c479064 @tombell Update the main README file to be more friendly
tombell authored
49 [hubot-scripts]: https://github.com/github/hubot-scripts
50 [hubot-scripts-readme]: https://github.com/github/hubot-scripts#readme
5abab75 @atmos require the callback, previous code didn't work
atmos authored
51
c479064 @tombell Update the main README file to be more friendly
tombell authored
52 ## Testing hubot locally
2d331f4 @holman very slightly improve the README
holman authored
53
54 Install all of the required dependencies by running `npm install`.
55
56 It's easy to test scripts locally with an interactive shell:
b253e94 @atmos fuck a color history
atmos authored
57
09e1a50 @atmos update PATH for local testing, fixes #106
atmos authored
58 % export PATH="node_modules/.bin:$PATH"
9ed55c6 @kneath As per 15cd8a18adb0ab56f1b7 stdio is default.
kneath authored
59 % bin/hubot
b253e94 @atmos fuck a color history
atmos authored
60
c479064 @tombell Update the main README file to be more friendly
tombell authored
61 ... and to run unit tests:
f5f6cec @technoweenie add a makefile for running tests
technoweenie authored
62
63 % make test
1455b62 Consistent whitespace
Tom Bell authored
64
Something went wrong with that request. Please try again.