@bbnet/roster/README.md

a list of known public federation servers

# roster

a non-authoritative, but hopefully complete list of public federation servers

## what do i do with this?

### help keep the list up to date!

first, [fork this] repo. then create a `<shortcode>.json` file in `src/` named with the
shortcode you have chosen for your instance:

```
{
  "shortcode": "<shortcode>",
  "name": "<long name>",
  "url": "<url>",
  "openRegistration": <boolean>
}
```

to update `data.json` do:

```sh
$ yarn run compile
```

[fork this]: https://source.heropunch.io/repo/fork/111

### use the list for something cool

- `https://source.heropunch.io/bbnet/roster/raw/latest/data.json`
- `yarn add @bbnet/roster`