diff --git a/README.md b/README.md index 38b56bb9..efa813b2 100644 --- a/README.md +++ b/README.md @@ -9,41 +9,35 @@ Semantic Release
- - Deps - - - Dev Deps - - + + Deps + + + Dev Deps + + Green Keeper [![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg)](#contributors) [![Chat on Slack](https://img.shields.io/badge/slack-join-ff69b4.svg)](https://join.slack.com/t/all-contributors/shared_invite/enQtNTE3ODMyMTA4NTk0LTUwZDMxZGZkMmViMzYzYzk2YTM2NjRkZGM5Yzc0ZTc5NmYzNWY3Y2Q0ZTY3ZmFhZDgyY2E3ZmIzNWQwMTUxZmE) -A bot for automatically adding all-contributors. - -Example usage screenshot +🤖 A GitHub bot to automate acknowledging contributors to your open source projects. -## Installation -[Install the GitHub App](https://github.com/apps/allcontributors) and [configure your repositories](https://github.com/apps/allcontributors/installations/new) +## Motivation +Implementing the [All Contributors spec](https://github.com/all-contributors/all-contributors) by hand is a laborious process. -## Usage +Enter the `@all-contributors bot`! The bot will automatically pull a user's profile, grab the contribution type emoji, update the project README and then open a Pull Request against the project :sparkles: -### Adding contributions -Comment on Issue or Pull Request with text: -``` -@all-contributors please add @jakebolam for infrastructure, tests and code -``` - -The bot will then create a Pull Request to add the contributor, then reply with the pull request details. - -> If this is your first time adding a contributor, you will need to ensure you have a `README.md` file in the root of the project (it can be empty). + + Example usage screenshot + +## Using the @all-contributors bot 🤖 +If you're looking to use the bot, head over to the [bot docs on all-contributors.js.org](https://all-contributors.js.org/docs/bot/overview). The all-contributors website contains all the information required to install, configure and use the bot. ## Contributing -If you have suggestions for how the AllContributorsBot could be improved, or want to report a bug, [open an issue](https://github.com/all-contributors/all-contributors-bot/issues)! +If you have suggestions for how the @all-contributors bot could be improved, or want to report a bug, [open an issue](https://github.com/all-contributors/all-contributors-bot/issues)! For more, check out the [Contributing Guide](CONTRIBUTING.md).