README.md

unrealircd-s2s-client

This is a simple library for interfacing with UnrealIRCD via the S2S interface.
You can use this to make custom bridges, or custom services packages for your network, as opposed to using Atheme or Anope.

Usage

Install the package via npm:

npm install unrealircd-s2s-client

Then, you can import it in your code like so:

import { ServerToServerClient, User, generateUID } from "unrealircd-s2s-client";

Example

See example.ts for a full example.