Skip to content
This repository has been archived by the owner on Oct 25, 2024. It is now read-only.

Add "how it works" section in readme #271

Merged
merged 6 commits into from
Jun 15, 2021
Merged

Add "how it works" section in readme #271

merged 6 commits into from
Jun 15, 2021

Conversation

majk-p
Copy link
Member

@majk-p majk-p commented Jun 15, 2021

No description provided.

@majk-p majk-p requested review from kubukoz and pkowalcze June 15, 2021 14:31
README.md Outdated
![Continuous Integration](https://github.com/pitgull/pitgull/workflows/Continuous%20Integration/badge.svg)
[![Powered by cats](https://img.shields.io/badge/powered%20by-cats-blue.svg)](https://github.com/typelevel/cats)
![Gluten free](https://img.shields.io/badge/gluten-free-orange.svg)

## How it works

The core idea behind the project is very simple - create a tool for automatically applying merge requests created by [Scala Steward](https://github.com/scala-steward-org/scala-steward) on any [Gitlab](https://gitlab.com/) instance.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was the core idea, but the app's goal is to be orthogonal from the bots making the PRs

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair point, added a sentence about this.

README.md Outdated Show resolved Hide resolved
majk-p and others added 3 commits June 15, 2021 16:47
@majk-p majk-p requested a review from kubukoz June 15, 2021 14:52
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
majk-p and others added 2 commits June 15, 2021 19:28
Co-authored-by: Patryk Kowalcze <pkowalcze@users.noreply.github.com>
Co-authored-by: Patryk Kowalcze <pkowalcze@users.noreply.github.com>
@majk-p majk-p merged commit 00867fc into main Jun 15, 2021
@majk-p majk-p deleted the how-it-works branch June 15, 2021 17:29
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants