aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorZoffix Znet <cpan@zoffix.com>2016-01-01 09:00:37 -0500
committerZoffix Znet <cpan@zoffix.com>2016-01-01 09:00:37 -0500
commit98cee4deebfba64dd7143f97675788b175fb8fb4 (patch)
tree4b10bbf17f16a603d89732cca24bf60e3ea70b3d /README.md
parentce9eb0ee6f2903c551f88f989ef17ef8f1dbdc1f (diff)
Add server password support (Relates to #3)
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2bb94a5..25fc9bd 100644
--- a/README.md
+++ b/README.md
@@ -77,6 +77,7 @@ method irc-all-events ($irc, $e) {
- [`new`](#new)
- [`debug`](#debug)
- [`host`](#host)
+ - [`password`](#password)
- [`port`](#port)
- [`nick`](#nick)
- [`username`](#username)
@@ -147,6 +148,7 @@ my $irc = IRC::Client.new;
my $irc = IRC::Client.new(
debug => False,
host => 'localhost',
+ password => 's3cret',
port => 6667,
nick => 'Perl6IRC',
username => 'Perl6IRC',
@@ -177,6 +179,14 @@ will be printed by the modules on the STDOUT. **Defaults to:** `False`
Specifies the hostname of the IRC server to connect to. **Defaults to:**
`localhost`
+### `password`
+
+```perl6
+ password => 's3cret',
+```
+Specifies the password for the IRC server. (on Freenode, for example, this
+is the NickServ password that identifies to services).
+
### `port`
```perl6