Scuttlebutt

<h1 align="center" style="font-size: 4em;">
  <img
    alt="Hermies the hermit crab"
    src="assets/hermies.png"
    width="256"
    height="256"
  />
  <br />
  Scuttlebutt
</h1>

<h2 align="center">
  a decent(ralised) secure gossip platform
</h2>

<h4 align="center">
  sea-slang for gossip - a scuttlebutt is basically a watercooler on a ship
</h4>

{% vimeo %}236358264{% endvimeo %}

## How To Get Started

The easiest way to get started is using [patchwork](https://github.com/ssbc/patchwork), a classic social networking [application](./applications.md).

![screenshot of patchwork](./assets/patchwork.jpg)

### Easy path

1. [Download an Installer](https://github.com/ssbc/patchwork/releases) for Windows, macOS and Linux
2. Get a [pub invite code](https://github.com/ssbc/scuttlebot/wiki/Pub-Servers)  
3. Use the pub invite : in Patchwork click `+ Join Pub` and paste the invite code

Step 2 is important if you want to be able to find people further than your local network - it sets you up with a robot friend on the internet which helps you find and communicate with people.
Read more about Pubs and their role [here](./concepts/pub.md).


### Build from Source

This is more technical than the easy path, mainly useful if you're interested in developing Patchwork.

On Linux you'll need some more dependencies. On Debian:

```shell
sudo apt-get install libxext-dev libxtst-dev libxkbfile-dev g++ m4 automake libtool
```

With [node (>= 4) and npm (>= 2) installed](https://github.com/creationix/nvm):

```shell
$ git clone https://github.com/ssbc/patchwork
$ cd patchwork
$ npm install
$ npm start
```

Follow steps `2.` and `3.` above to connect to the network.


## Join The Community

Check out the following channels by typing their name (with #) in the search bar:
- **#new-people**: introduce yourself
- **#faq**: first impressions, what is confusing as a new user?
- **#patchwork**: report bugs, suggestions, etc
- **#scuttlebutt**: protocol related discussion

Here are some other favourites:
- **#boats**: people living on, hacking, and bulding boats
- **#cooking-channel**: nerds sharing recipes
- **#solarpunk**: step into the future
- **#gardening**: get some gardening on with your off-grid
- **#anarchitecture**: decentralise all the things

## Code of conduct

Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms.

## About This Handbook

To view the public handbook, browse to [scuttlebutt.nz](https://www.scuttlebutt.nz)

The handbook is organized by topics:

* [Contributing](contributing.md)
* [Talks](talks.md)
* [Applications](applications.md)
* [Principles](principles.md)
* [FAQ](faq/index.md)
* [Stories](stories/index.md)
* [Modules](modules.md)
* [Concepts](concepts/index.md)
* [Guides](guides/index.md)
* [Glossary](glossary.md)

## Other documentation

Over time we have scattered documentation around in a few places:

- [scuttlebot.io](https://scuttlebot.io)
- [ssbc.github.io](https://ssbc.github.io)

[Please help us consolidate this here](contributing.md#contributing-documentation)!