From 2a9a1bf803697d48f0e8f1bdbc5952cb0ef1b6dc Mon Sep 17 00:00:00 2001
From: Conrad <grosserconrad@gmail.com>
Date: Tue, 6 Oct 2020 14:23:31 +0200
Subject: [PATCH] Add readme and commit options

---
 README.md  | 52 +++++++++++++++++++++++++++++++++++++++++++++++++++-
 action.yml |  5 ++++-
 2 files changed, 55 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 80b7774..a9b7e8c 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,51 @@
-# django_action
\ No newline at end of file
+# Django Action
+
+A GitHub action for drawing a Django data model automatically.
+
+## Usage
+
+### Parameters
+
+| Parameter      | Required |      Default      | Description                              |
+| -------------- | :------: | :---------------: | ---------------------------------------- |
+| commit_options |   :x:    |         -         | Custom git commit options                |
+| commit_message |   :x:    | Added data schema | Custom git commit message                |
+| file_pattern   |   :x:    |        \*         | Custom git add file pattern              |
+| output_path    |   :x:    |         .         | Output path for generated files          |
+| pip_path       |   :x:    | requirements.txt  | Requirements path for the Django project |
+
+### Example Config
+
+```yaml
+name: Continuous Integration
+
+# This action works with pull requests and pushes
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          # Make sure the actual branch is checked out when running on pull requests
+          ref: ${{ github.head_ref }}
+
+      - name: Generate Data Schema
+        uses: noah-software/django_action@v1.0
+        with:
+          # This part is also where you can pass other options, for example:
+          pip_path: testfolder/app/requirements.txt
+```
+
+More documentation for writing a workflow can be found [here](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions).
+
+## Issues
+
+Please report all bugs and feature request using the [GitHub issues function](https://github.com/noah-software/django_action/issues/new). Thanks!
diff --git a/action.yml b/action.yml
index 28cdf0e..9d70cc7 100644
--- a/action.yml
+++ b/action.yml
@@ -7,7 +7,10 @@ inputs:
   output_path:
     description: Output path for the generated data scheme
     required: false
-    default: "./"
+    default: "."
+  commit_options:
+    description: Commit options for the changed data
+    required: false
   commit_message:
     description: Commit message of the changed data
     required: false