probot/README.md

# Probot

Probot is a bot framework for GitHub. It's like [Hubot](https://hubot.github.com/), but for GitHub instead of chat.

If you've ever thought, "wouldn't it be cool if GitHub could…"; imma stop you right there. Most features can actually be added via [GitHub Apps](https://developer.github.com/apps/), which extend GitHub and can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. Apps are first class actors within GitHub.

There are some great services that offer [apps in the GitHub Marketplace](https://github.com/marketplace), and you can build a bunch of really cool things yourself. Probot aims to make that easy.

## Plugins

Bots are implemented as plugins, which are easy to write, deploy, and share. Here are just a few examples of things probot can do:

- [stale](https://github.com/probot/stale) - closes abandoned issues after a period of inactivity.
- [owners](https://github.com/probot/owners) - @mentions people in Pull Requests based on contents of the OWNERS file
- [configurer](https://github.com/probot/configurer) - syncs repository settings defined in `.github/config.yml` to GitHub, enabling Pull Requests for repository settings.

Check out [all probot plugins](https://github.com/search?q=topic%3Aprobot-plugin&type=Repositories).

## Contributing

Most of the interesting things are built with plugins, so consider starting by [writing a new plugin](docs/plugins.md) or improving one of the [existing ones](https://github.com/search?q=topic%3Aprobot-plugin&type=Repositories).

Want to chat with Probot users and contributors? Join us in the [Slack channel](https://probot-slackin.herokuapp.com/badge.svg)](https://probot-slackin.herokuapp.com/)!
Add plugin docs 2017-03-12 23:48:09 +08:00			`# Probot`
README driven development 2016-09-17 00:06:46 +08:00
a 2017-03-28 04:06:04 +08:00			`Probot is a bot framework for GitHub. It's like [Hubot](https://hubot.github.com/), but for GitHub instead of chat.`
README is aspirational 2016-09-17 06:00:20 +08:00
Update name from "GitHub Integrations" to "GitHub Apps" 2017-06-06 10:04:26 +08:00			`If you've ever thought, "wouldn't it be cool if GitHub could…"; imma stop you right there. Most features can actually be added via [GitHub Apps](https://developer.github.com/apps/), which extend GitHub and can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. Apps are first class actors within GitHub.`
WIP: readme 2017-03-12 12:50:33 +08:00
Update name from "GitHub Integrations" to "GitHub Apps" 2017-06-06 10:04:26 +08:00			`There are some great services that offer [apps in the GitHub Marketplace](https://github.com/marketplace), and you can build a bunch of really cool things yourself. Probot aims to make that easy.`
README driven development 2016-09-17 00:06:46 +08:00
Tweak README 2017-03-20 12:01:03 +08:00			`## Plugins`
README driven development 2016-09-17 00:06:46 +08:00
Tweak README 2017-03-20 12:01:03 +08:00			`Bots are implemented as plugins, which are easy to write, deploy, and share. Here are just a few examples of things probot can do:`
Added two further examples and kept the original example in README.md 2016-12-08 01:53:44 +08:00
Tweak README 2017-03-20 12:01:03 +08:00			`- [stale](https://github.com/probot/stale) - closes abandoned issues after a period of inactivity.`
			`- [owners](https://github.com/probot/owners) - @mentions people in Pull Requests based on contents of the OWNERS file`
			- [configurer](https://github.com/probot/configurer) - syncs repository settings defined in `.github/config.yml` to GitHub, enabling Pull Requests for repository settings.
Added two further examples and kept the original example in README.md 2016-12-08 01:53:44 +08:00
Tweak README 2017-03-20 12:01:03 +08:00			`Check out [all probot plugins](https://github.com/search?q=topic%3Aprobot-plugin&type=Repositories).`
Update readme to reflect composable behaviors 2016-10-11 00:34:33 +08:00
Tweak README 2017-03-20 12:01:03 +08:00			`## Contributing`
Docs on installing 2016-10-13 11:24:48 +08:00
Tweak README 2017-03-20 12:01:03 +08:00			`Most of the interesting things are built with plugins, so consider starting by [writing a new plugin](docs/plugins.md) or improving one of the [existing ones](https://github.com/search?q=topic%3Aprobot-plugin&type=Repositories).`
Add link to slack channel 2017-08-23 05:33:47 +08:00
			`Want to chat with Probot users and contributors? Join us in the [Slack channel](https://probot-slackin.herokuapp.com/badge.svg)](https://probot-slackin.herokuapp.com/)!`