add a simple readme

ClearTax · Sep 14, 2019 · 6777e99 · 6777e99
1 parent ecbfbde
commit 6777e99
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,18 @@
-# JavaScript Action Template
+# PR Lint
 
-This template offers an easy way to get started writing a JavaScript action with TypeScript compile time support, unit testing with Jest and using the GitHub Actions Toolkit.
+PR Lint checks for a pivotal story id in the branch name. It uses the pivotal API so any random
+pivotal id will lead to check failure.
 
-## Getting Started
+PR Lint will also add the team label based on the pivotal project board for the given story
 
-See the walkthrough located [here](https:/actions/toolkit/blob/master/docs/typescript-action.md).
+## FAQs
 
-In addition to walking your through how to create an action, it also provides strategies for versioning, releasing and referencing your actions.
+<details>
+ <summary>Why pivotal id is required?</summary>
+</details>
+
+<details>
+ <summary>Are there any tools to help to automate this?</summary>
+ Yes,
+ check out https://www.npmjs.com/package/pivotal-flow
+</details>
diff --git a/docs/contributors.md b/docs/contributors.md