Merge pull request #1 from sammychinedu2ky/master

chore:added docs

.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}}'

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}}'
+```

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