# Buoy: A community-based crisis response system

[![Join the project chat room](https://badges.gitter.im/betterangels/buoy.svg)](https://gitter.im/betterangels/buoy) [![Build Status for develop branch](https://travis-ci.org/betterangels/buoy.svg?branch=develop)](https://travis-ci.org/betterangels/buoy) [![Download Buoy from WordPress.org](https://img.shields.io/wordpress/plugin/dt/buoy.svg)](https://wordpress.org/plugins/buoy/) [![Current release at WordPress.org](https://img.shields.io/wordpress/plugin/v/buoy.svg)](https://wordpress.org/plugins/buoy/) [![Required WordPress version](https://img.shields.io/wordpress/v/buoy.svg)](https://wordpress.org/plugins/buoy/developers/) [![Buoy is licensed GPL-3.0](https://img.shields.io/github/license/betterangels/buoy.svg)](https://www.gnu.org/licenses/quick-guide-gplv3.en.html)

<img src="https://ps.w.org/buoy/assets/icon-256x256.png?rev=1397119" alt="" align="right" />

Buoy is a decentralized 9-1-1 alternative built for and by people who are not well served by existing emergency response services. Buoy makes it easy to tell your friends where you are and what you need. Buoy's goal is a world where anyone in distress always has the option to turn to people they trust for support, rather than being forced to rely on people they don't.

Buoy is not a traditional "app" that you can download in the app store, but rather a system for adding crisis response and emergency dispatch services to existing websites. With Buoy, community groups, activist organizations, and social support service providers can quickly connect people who need help with trusted friends, family members, advocates, and other allies who can help them. It is designed to be community owned and operated, so each instance of Buoy can be customized to the unique needs or the organization or community group that hosts it.

Whether you are a group of street medics coordinating with each other during an action, citizen journalists or copwatchers watching each other's backs, domestic violence survivor support advocates, or even single parents picking each others’ kids up from school, Buoy helps you get and give peer-based mutual aid to your friends and comrades.

* **See the [screenshots](https://wordpress.org/plugins/buoy/screenshots/) for an example walkthrough of how Buoy works.**
* [Find a Buoy-enabled web site.](https://github.com/betterangels/buoy/wiki/List-of-Buoy-enabled-websites)
* [Learn more about Buoy](https://github.com/betterangels/buoy/wiki).

# [Installing Buoy for your community](https://github.com/betterangels/buoy/wiki/Install)

If you already have a WordPress website, Buoy can be installed automatically from the WordPress plugin directory by searching for "Buoy" in the "Add New Plugin" screen of your WordPres admin site and clicking the "Install now" button. ([Learn more about installing WordPress plugins from WPBeginner.com](http://www.wpbeginner.com/beginners-guide/step-by-step-guide-to-install-a-wordpress-plugin-for-beginners/).)

# [Contributing](https://github.com/betterangels/buoy/wiki/Contributor-guidelines)

Buoy is [free software](https://www.gnu.org/philosophy/free-sw.en.html "What is free software?"). It was developed and is maintained primarily by a nomadic hacker named [maymay](https://maymay.net/) who has a lot of fucks to give about supporting survivors of any of capitalism's horrors, along with a growing group of volunteers who call themselves the [Better Angels](https://betterangels.github.io/).

Even if you don't code, there's a lot you can do to help make Buoy better. Here are a few.

## Donate

You can support development and maintenance of Buoy by [donating to our crowdfunding campaign](https://www.generosity.com/community-fundraising/buoy-empowering-community-based-crisis-response), or by directly supporting its primary developer, [maymay](https://maymay.net/). Click [here to donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=TJLPJYXHSRBEE&lc=US&item_name=Better%20Angels%20Buoy&item_number=Better%20Angels%20Buoy&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted), or visit [Cyberbusking.org](http://Cyberbusking.org/) for maymay's personal donation portal.

## Translate

If you speak multiple languages, you can help [translate Buoy into more human languages](https://www.transifex.com/cyberbusking/better-angels/). This helps make Buoy available to people all over the world in their native languages.

Learn more by reading our [Translator instructions](https://github.com/betterangels/buoy/wiki/Translator-instructions).

## Document

If you use Buoy and are familiar with how it works, you can help others learn about the tool by writing about how you use it. We maintain [a wiki](https://github.com/betterangels/buoy/wiki) that you can edit to add your own guides, walkthroughs, and suggestions.

You can also write articles on your website or blog. If you do, please [connect with us over social media or email](https://betterangels.github.io/) to let us know.

## Code

The easiest way to get started contributing code is to use the [Varying Vagrant Vagrants](https://github.com/Varying-Vagrant-Vagrants/VVV) ("VVV") project to make a local WordPress development environment. Then [fork the Buoy project on GitHub](https://github.com/betterangels/buoy/fork) and `git clone` your fork into your VVV's `wordpress-default/wp-content/plugins/` directory. See our wiki for a step-by-step guide to [setting up a development environment](https://github.com/betterangels/buoy/wiki/Setting-up-a-development-environment).

Patches and pull requests are very welcome! More information at our [Developer documentation](https://github.com/betterangels/buoy/wiki/Developer-documentation).
