From def73788ff3dead0a341bffe1697890d11ce5782 Mon Sep 17 00:00:00 2001
From: Tatsuya Sato <satoryu.1981@gmail.com>
Date: Sat, 20 May 2023 00:29:53 +0900
Subject: [PATCH] Add README

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..72de891
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# Labeling by GPT
+
+When creating new issue, this action puts labels to an issues in the repository autocratically without pre-defined rule.
+This is powered by OpenAI completion API to choose suitable labels.
+
+Please note that this action supports only `issues` trigger and the two types: `opened` and `edited`.
+
+## Inputs
+
+### `openai-api-key`
+
+**Required** Your OpenAI API Key.
+
+### `github-token`
+
+Optional.
+GitHub API token to access GitHub API.
+The default value is `secrets.GITHUB_TOKEN`, an API token provided for an action.
+Be sure of that this token has a permission to put labels to an issue.
+[This document](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository) would help you.
+
+## Example
+
+```yaml
+on:
+  issues:
+    types: [opened, edited]
+
+jobs:
+  test:
+    name: test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: satoryu/labeling-by-gpt@main
+        with:
+          openai-api-key: ${{ secrets.OPENAI_API_KEY }}
+```