Merge pull request #2 from github/README

docs: Add project description
github · Jun 1, 2023 · 7f8efc9 · 7f8efc9
2 parents ed9437a + 01456ad
commit 7f8efc9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.9, 3.11]
+        python-version: [3.11]
 
     steps:
     - uses: actions/checkout@v3

diff --git a/README.md b/README.md
@@ -1,6 +1,11 @@
 # Issue Metrics Action
 
-TODO: repo description
+This is a GitHub Action that searches for pull requests/issues in a repository and measures
+the time to first response for each issue. It then calculates the average time
+to first response and writes the issues with their time to first response to a
+Markdown file. The issues to search for can be filtered by using a search query.
+
+To find syntax for search queries, check out the [documentation](https://docs.github.com/en/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests).
 
 ## Support