Merge pull request #7 from beeceej/readme-updates

LGTM: readme and documentation cleanup

.github/workflows/action.yaml

@@ -5,12 +5,11 @@ on:
 jobs:
   lgtm:
     runs-on: ubuntu-latest
-    name: A job to say hello
+    name: True meaning of LGTM
     steps:
     - name: Checkout
       uses: actions/checkout@v2
     - name: LGTM
       uses: ./
       env:
         GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        OCAMLRUNPARAM: b

README.md

@@ -1 +1,40 @@
 # LGTM
+
+Who knows what the heck LGTM even stands for anyway?
+
+Let's Get This Merged?
+
+Let's Get this Money?
+
+Looks Good To me?
+
+something else?
+
+This is an action that responds to the acronym in Pull Requests or issues with the true meaning of LGTM, or atleast up to the Random Number Generator.
+
+Setup:
+
+Add the `GH_TOKEN` secret to your repo with a token that has permission to comment on Issues.
+
+
+```
+cat .github/workflows/action.yaml
+
+---
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  lgtm:
+    runs-on: ubuntu-latest
+    name: True meaning of LGTM
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: LGTM
+      uses: beeceej/[email protected]
+      env:
+        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```

src/main.ml

@@ -9,7 +9,7 @@ module LgtmAcronym = struct
     let g = rand_from_list Words.g in
     let t = rand_from_list Words.t in
     let m = rand_from_list Words.m in
-    Printf.sprintf "*%s* *%s* *%s* *%s*" l g t m
+    Printf.sprintf "**%s** **%s**  **%s**  **%s**" l g t m
 end
 
 module Github = struct