From 77da00eba04d9756dd8c4e703c5ef65f24ee5160 Mon Sep 17 00:00:00 2001
From: Conrad <grosserconrad@gmail.com>
Date: Fri, 10 Jan 2020 10:21:21 +0100
Subject: [PATCH] Added proper README

---
 README.md | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 8e061c8..c3a7910 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,19 @@
-# prettier_action
-GitHub action for running prettier on your projects pull requests
+# GitHub Prettier Action
+
+A GitHub action for styling files with [prettier](prettier.io).
+
+## Usage
+
+### Parameters
+
+| Parameter | Required | Default | Description |
+| - | - | - | - |
+| prettier_options | :white_check_mark: | - | Prettier options |
+| commit_options | :x: | - | Custom git commit options |
+| commit_message | :x: | 'Prettified Code!' | Custom git commit message |
+| file_pattern | :x: | '*' | Custom git add file pattern |
+| branch | :white_check_mark: | - | Custom git publish branch, use ${{ github.head_ref }} if used in pull requests |
+
+## Issues
+
+Please report all bugs and feature request using the [GitHub issues function](https://github.com/creyD/prettier_action/issues/new).