dev: Update docs for initial release (#20)

* dev: Update docs for initial release * Update action.yaml * dev: do not log context
streetsidesoftware · Dec 17, 2020 · e559279 · e559279
1 parent 50de4e8
commit e559279
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,10 @@
-# [WIP] cspell-action
-GitHub Action: Check Spelling
+# cspell-action
+Uses [cspell](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell) to check code.
 
-## Pull Requests
+## Installation
 
-## Push
+```yaml
+- uses: streetsidesoftware/cspell-action@v1
+    with:
+    github_token: ${{ secrets.GITHUB_TOKEN }}
+```
diff --git a/action-source/lib/main.ts b/action-source/lib/main.ts
@@ -65,7 +65,6 @@ async function action() {
     const context = gitHubApi.context;
 
     const github = getOctokit(getGithubToken());
-    core.info(`context: ${JSON.stringify(context, null, 2)}`);
 
     switch (context.eventName) {
         case 'push':

diff --git a/action.yaml b/action.yaml
@@ -1,13 +1,10 @@
 name: 'cspell-action'
-description: 'Spell check changed files.'
+description: 'Spell Checker for Code'
 author: 'Street Side Software <[email protected]>'
 inputs:
     github_token:
         description: 'Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }}'
         required: true
-outputs:
-    time:
-        description: 'Finish time.'
 runs:
     using: 'node12'
     main: './action/main.js'

diff --git a/action/main.js b/action/main.js
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cspell-action",
-  "version": "1.0.0",
+  "version": "0.1.0",
   "description": "GitHub Action: Check Spelling",
   "main": "action/main.js",
   "private": true,
@@ -26,6 +26,7 @@
     "cspell",
     "Action",
     "cspell",
+    "spell",
     "spelling",
     "checker"
   ],