From 630388e10929438b51df259d4d8721734766417f Mon Sep 17 00:00:00 2001 From: Stas Marazevich Date: Tue, 19 Sep 2023 15:03:23 +0200 Subject: [PATCH] fix: update readme --- README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index fa61bd1..73aa878 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,20 @@ -[![CircleCI](https://circleci.com/gh/tabomors/issues-finder.svg?style=svg)](https://circleci.com/gh/tabomors/issues-finder) +![Lint and Format](https://github.com/tabomors/issues-finder/actions/workflows/lint.yaml/badge.svg) +![Create Release](https://github.com/tabomors/issues-finder/actions/workflows/release.yaml/badge.svg) +![Vercel Production Deployment](https://github.com/tabomors/issues-finder/actions/workflows/deploy-prod.yaml/badge.svg) -# POC of app for searching github issues by label and language +# Small app for searching github issues by label and language -This app can help you find issue by label and language. - -It may be useful if you want to start contributing to open source, but can't find any simple issues. - -For example you can choose `Javascript` lang and `good-first-issue` label and it will show you a list of issues. +This app can help you find issues by label and language. It might be helpful if you are searching for issues to contribute to on GitHub. For example, you can choose the `JavaScript`` language and the `good-first-issue`` label, and it will show you a list of issues with that label. # Motivation 1. I created it for myself in order to find issues to contribute -2. I created this project with modern stack because i will use this stack on the next project at work. So in general i think it is overkill to use these technologies for this tiny app +2. I created this project with modern stack because i will use this stack on the next project at work. -Stack: +# Stack: - TypeScript - Next.js -- Apollo +- React Query - Code generation for graphql -- Docker -- CircleCI +- Github Actions