readme tweaks

projectwallace · Mar 26, 2020 · 2f328fb · 2f328fb
1 parent 369c078
commit 2f328fb
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 13 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -1,4 +1,4 @@
-name: CSS Workflow
+name: CSS Quality
 
 on:
   pull_request:

diff --git a/README.md b/README.md
@@ -1,22 +1,16 @@
 # Project Wallace Diff Github Action
 
-This GitHub actions posts your CSS to [projectwallace.com](https://www.projectwallace.com?ref=gh-diff-action), calculats the change between the current state of your project and your PR, and comments the diff in the PR.
+This GitHub actions posts your CSS to [projectwallace.com](https://www.projectwallace.com?ref=gh-diff-action), calculates the change between the current state of your project and your PR, and comments the diff in the PR.
 
 ## Usage
 
 ### Inputs
 
-#### github-token
-
-**Required** Must be in the form `github-token: ${{ secrets.GITHUB_TOKEN }}`. This Action uses this token to post a comment with the diff.
-
-#### project-wallace-token
-
-**Required** The webhook token for your project on projectwallace.com. You can find this token in the project settings. You must add this token to your repository secrets first! Example: `project-wallace-token: ${{ secrets.PROJECT_WALLACE_TOKEN }}`
-
-#### css-path
-
-**required** Path to the CSS file that should be analyzed and compared to the data on projectwallace.com. Example: `css-path: ./build/style.css`.
+| Name                    | Required   | Example                                                       | Description                                                                                                                                                                                                                                                                                                     |
+| ----------------------- | ---------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `github-token`          | _required_ | `github-token: ${{ secrets.GITHUB_TOKEN }}`                   | This Action uses this token to post a comment with the diff.                                                                                                                                                                                                                                                    |
+| `project-wallace-token` | _required_ | `project-wallace-token: ${{ secrets.PROJECT_WALLACE_TOKEN }}` | The webhook token for your project on projectwallace.com. You can find this token in the project settings. You must add this token to your [repository secrets](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets) first! |
+| `css-path`              | _required_ | `css-path: ./build/style.css`                                 | Path to the CSS file that should be analyzed and compared to the data on projectwallace.com.                                                                                                                                                                                                                    |
 
 ### Example