From ba272f5782f832cb6237bfba59d181ee5b66be19 Mon Sep 17 00:00:00 2001
From: Vinay Sharma <vinay04sharma@icloud.com>
Date: Fri, 25 Oct 2019 22:23:55 +0530
Subject: [PATCH] update(readme): add usage

---
 README.md  | 34 ++++++++++++++++++++++------------
 action.yml |  4 ++--
 2 files changed, 24 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 5eaaa43..40f458e 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,31 @@
-# first-action
+# Latex Action 
 
-This action prints "Hello World" or "Hello" + the name of a person to greet to the log.
+This action compiles latex file using Tectonic, which automatically downloads required dependencies.
+More Information about tectonic can be found [here](https://tectonic-typesetting.github.io/en-US/).
 
 ## Inputs
 
-### `who-to-greet`
+### `tex-path`
 
-**Required** The name of the person to greet. Default `"World"`.
+**Required** Path of tex, xtx file to compile.
 
 ## Outputs
-
-### `time`
-
-The time we greeted you.
+Pushes a Compiled PDF file parallel to the tex, xtx file.
 
 ## Example usage
-
-uses: actions/hello-world-docker-action@v1
-with:
-  who-to-greet: 'Mona the Octocat'
\ No newline at end of file
+```
+on: [push]
+
+jobs:
+  latex-job:
+    runs-on: ubuntu-latest
+    name: A job to Compile Latex file
+    steps:
+    - uses: actions/checkout@v1
+    - name: Compilation
+      uses: vinay0410/tectonic-action@master
+      env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tex_path: 'dir/file.tex'
+```
\ No newline at end of file
diff --git a/action.yml b/action.yml
index c8d4706..1da80e5 100644
--- a/action.yml
+++ b/action.yml
@@ -2,11 +2,11 @@
 name: 'Latex Compile'
 description: 'Compile Latex Files'
 inputs:
-  tex-path:  # id of input
+  tex_path:  # id of input
     description: 'Path of Tex File'
     required: true
 runs:
   using: 'docker'
   image: 'Dockerfile'
   args:
-    - ${{ inputs.tex-path }}
\ No newline at end of file
+    - ${{ inputs.tex_path }}
\ No newline at end of file