[irc/freenode/Sigyn.git] / README.md

# Sigyn

A Limnoria plugin to handle spam and abuse on a network level.

Sigyn is developed primarily for the freenode IRC network. As with most of
freenode's utility bots, Sigyn is named after a
[Norse goddess](https://en.wikipedia.org/wiki/Sigyn).

## Installation

If you're running this on a production network, you should probably use the
latest stable release. The master branch is considered unstable and may break at
any time.

See the [wiki](https://github.com/freenode/Sigyn/wiki) for setup instructions
and commands, as well as a work-in-progress configuration manual.

## Requesting Sigyn to your channel

The best way is to discuss with a staffer, you could also ask for her presence temporary (duration varies), with an `/invite Sigyn` (reviewed by staff).

But as invite notification can be missed, feel free to join `#freenode-sigyn` and ask in there.

If opped in your channel you can ask Sigyn to unkline an user, `/msg Sigyn unkline <nick>`, you have a dozen minutes to do so after the kill/kline, it only works if the user was banned due to abuse detected in your channel.

## Support and Development

[![#freenode-sigyn](https://kiwiirc.com/buttons/chat.freenode.net/freenode-sigyn.png)](https://kiwiirc.com/client/chat.freenode.net/#freenode-sigyn)
is where all the support and development happens. See `CONTRIBUTING.md` for rules
about creating issues and opening PRs.

## Code of Conduct

We enforce the
[Contributor Covenant, version 1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html),
which can be summed up as: Be respectful to everyone, and act in a constructive,
professional manner towards everyone. If you feel someone is violating the Code
of Conduct, please PM me (niko) on IRC, or email me at niko@freenode.net.
Commit	Line	Data
713c8b0e	1	# Sigyn
6f7f2f85	2
8bd4f280	3	A Limnoria plugin to handle spam and abuse on a network level.
6f7f2f85	4
94de5574	5	Sigyn is developed primarily for the freenode IRC network. As with most of
c9644292 EV	6	freenode's utility bots, Sigyn is named after a
c9644292 EV	7	[Norse goddess](https://en.wikipedia.org/wiki/Sigyn).
1d9adcdf	8
8bd4f280	9	## Installation
6f7f2f85	10
713c8b0e EV	11	If you're running this on a production network, you should probably use the
	12	latest stable release. The master branch is considered unstable and may break at
	13	any time.
6f7f2f85	14
713c8b0e EV	15	See the [wiki](https://github.com/freenode/Sigyn/wiki) for setup instructions
713c8b0e EV	16	and commands, as well as a work-in-progress configuration manual.
6f7f2f85	17
408f9235 NC	18	## Requesting Sigyn to your channel
408f9235 NC	19
0c6fd5eb	20	The best way is to discuss with a staffer, you could also ask for her presence temporary (duration varies), with an `/invite Sigyn` (reviewed by staff).
40b9d04a	21
0c6fd5eb	22	But as invite notification can be missed, feel free to join `#freenode-sigyn` and ask in there.
408f9235	23
0c6fd5eb	24	If opped in your channel you can ask Sigyn to unkline an user, `/msg Sigyn unkline <nick>`, you have a dozen minutes to do so after the kill/kline, it only works if the user was banned due to abuse detected in your channel.
40b9d04a	25
8bd4f280	26	## Support and Development
6f7f2f85	27
fff82d0d	28	[![#freenode-sigyn](https://kiwiirc.com/buttons/chat.freenode.net/freenode-sigyn.png)](https://kiwiirc.com/client/chat.freenode.net/#freenode-sigyn)
0c6fd5eb	29	is where all the support and development happens. See `CONTRIBUTING.md` for rules
fff82d0d	30	about creating issues and opening PRs.
8bd4f280 EV	31
	32	## Code of Conduct
	33
c9644292 EV	34	We enforce the
	35	[Contributor Covenant, version 1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html),
	36	which can be summed up as: Be respectful to everyone, and act in a constructive,
8bd4f280	37	professional manner towards everyone. If you feel someone is violating the Code
c1720845	38	of Conduct, please PM me (niko) on IRC, or email me at niko@freenode.net.