From 9519b9456a33884da6bcfe3d1c54984bd60bde36 Mon Sep 17 00:00:00 2001
From: sammychinedu2ky <sammychinedu2ky@gmail.com>
Date: Sun, 7 Mar 2021 06:02:40 +0100
Subject: [PATCH] chore:added docs

---
 .github/workflows/main.yml |  2 +-
 README.md                  | 34 ++++++++++++++++++++++++++++++++--
 action.yml                 |  2 +-
 sammychinedu2ky            |  1 -
 4 files changed, 34 insertions(+), 5 deletions(-)
 delete mode 100644 sammychinedu2ky

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 92f5934..2d37970 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Use Issue Management Action
-        uses: chaiforc7/meflow@main
+        uses: sammychinedu2ky/issue-man@main
         with:
           myToken: '${{ secrets.GITHUB_TOKEN }}'
           key: '${{secrets.KEY}}'
diff --git a/README.md b/README.md
index 1743ee1..04e2f12 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,32 @@
-# meflow
-[![mynodeflow](https://github.com/chaiforc7/meflow/actions/workflows/main.yml/badge.svg)](https://github.com/chaiforc7/meflow/actions/workflows/main.yml)
+
+# issue-man
+
+[![mynodeflow](https://github.com/sammychinedu2ky/meflow/actions/workflows/main.yml/badge.svg)](https://github.com/sammychinedu2ky/meflow/actions/workflows/main.yml)
+
+```markdown
+# GitHub Issues Management Action
+
+This action warns users when adult content is posted
+
+## Inputs
+
+### `myToken`
+
+**Required** Your GitHub Token.
+
+### `key`
+
+**Required** The Key of your Azure Computer Vision Resource.
+
+### `endpoint`
+
+**Required** The endpoint of your Azure Computer Vision Resource.
+```
+## Example usage
+```
+uses: sammychinedu2ky/issue-man@main
+with:
+  myToken: '${{ secrets.GITHUB_TOKEN }}'
+  key: '${{secrets.KEY}}'
+  endpoint: '${{secrets.ENDPOINT}}'
+```
\ No newline at end of file
diff --git a/action.yml b/action.yml
index 29858aa..8ae5728 100644
--- a/action.yml
+++ b/action.yml
@@ -1,5 +1,5 @@
 name: An issue moderation bot
-description: ' Warn users when adult content is posted'
+description: ' Warns users when adult content is posted'
 branding:
   icon: anchor
   color: green
diff --git a/sammychinedu2ky b/sammychinedu2ky
deleted file mode 100644
index 85dce2e..0000000
--- a/sammychinedu2ky
+++ /dev/null
@@ -1 +0,0 @@
-sammychinedu2ky