Merge pull request #4 from softrams/setting-open-source

Updating Readme & Getting project setup for open source

Author: DarrellRichards

LICENSE

@@ -0,0 +1,24 @@
+MIT License
+
+Copyright (c) 2024 Softrams LLC
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,61 @@
+<div align="center">
+
+![Pull Request Magic](docs/images/multi_color.png#gh-light-mode-only)
+
+![Pull Request Magic](docs/images/white.png#gh-dark-mode-only)
+
+# Magic Automating Pull Request
+
+AI Powered Automation for Pull Requests, We're here to help understand and grow the ability to automate a Pull Request. 
+
+</div>
+
+## ✨ Features
+
+- Line by line code review
+- Overall Summary of the Pull Request in a comment
+- Rewritting or Writing a Pull Request Desciption based on Pull Request Code
+- Auto Approving of Pull Request
+- Merging of Pull Request (🔥 Coming Soon)
+
+## 🚀 Usage
+
+### 👁️ Basic Setup
+```yaml
+name: AI Code Reviewer
+
+on: 
+    pull_request:
+        types:
+            [
+                opened,
+                reopened, 
+                synchronize
+            ]
+
+jobs: 
+    code_review:
+        runs-on: ubuntu-latest
+        steps: 
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: AI Reviewer
+              uses: softrams/[email protected]
+              with: 
+                github_token: ${{ secrets.GITHUB_TOKEN }}
+                openai_api_key: ${{ secrets.OPENAI_API_KEY }}
+```
+
+## 🔥 Configurable Fields
+Below is a list of configurable fields that can be used with the ***Magic Github Action***
+
+| Name | Type | Default Value | Required |
+|--|--|--|--|
+| github_token | string | none | yes |
+| openai_api_key | string | none | yes |
+| excluded_files | []string | ['node_modules, package-lock.json, yarn.lock'] | no |
+| openai_model | string | 'gpt-4' | no |
+| review_code | boolean | true | no |
+| generate_summary | boolean | false | no |
+| overall_code_review | boolean | false | no |
+| auto_approve | boolean | false | no |