← Back to branch summary

~unmaintained-charms/charms/precise/bitlbee/trunk

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Charles Butler
  • Date: 2014-04-16 02:46:17 UTC
  • mfrom: (14.1.3 bitlbee)
  • Revision ID: chuck@dasroot.net-20140416024617-339i8flvh69qr42m
[José Antonio Rey] Added more detail to README and formatted to markdown, added icon

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.md
 
1
# Overview
 
2
 
 
3
This is a charm for BitlBee, the IM to IRC gateway.
 
4
 
 
5
For more information on bitlbee itself, see the
 
6
[documentation on the web site](http://www.bitlbee.org/main.php/extdoc.html)
 
7
 
 
8
# Usage
 
9
 
 
10
To deploy Bitblee, execute the following commands:
 
11
 
 
12
    juju bootstrap
 
13
    juju deploy bitlbee
 
14
 
 
15
Then, expose the service to the world:
 
16
 
 
17
    juju expose bitlbee
 
18
 
 
19
If you want to get the public IP/DNS, do:
 
20
 
 
21
    juju status
 
22
 
 
23
# Configuration
 
24
 
 
25
At the moment the only configuration option is the port for BitlBee to listen
 
26
on. By default, this port is 6667, but you can change it to any port you would
 
27
like.
 
28
 
 
29
In order to change the port, execute:
 
30
 
 
31
    juju set bitlbee port=[portnumber]
 
32
 
 
33
# Contact Information
 
34
 
 
35
## Bitlbee
 
36
 
 
37
 - [Bitlbee website](http://bitlbee.org/)
 
38
 - [Bitlbee Wiki](http://wiki.bitlbee.org/)
 
39
 - [Bitlbee bug tracker](http://bugs.bitlbee.org/)