---
id: overview
title: Bot Overview
sidebar_label: Overview
---

<a href="https://github.com/all-contributors/app/releases">
    <img alt="Bot Latest Release" src="https://img.shields.io/github/release/all-contributors/all-contributors-bot.svg"/>
</a>
<a class="github-button" href="https://github.com/all-contributors/app" data-icon="octicon-star" data-count-href="/all-contributors/all-contributors-bot/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub" >Star</a>

🤖 A GitHub bot to automate acknowledging contributors to your open source projects.

## Motivation

Implementing the [All Contributors spec](../specification) by hand is a laborious process.

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
<a href="usage">
    <img alt="Example usage screenshot" src="../../assets/bot-usage.png" width="500px">
</a>

- [Installing the Bot](installation)
- [Using the Bot](usage)
- [Configuring the Bot](configuration)
- [Frequently Asked Questions](faq)
