docs: prepare documentation for v1.0.0 release 🎉 (#8)

Author: felangel

CHANGELOG.md

@@ -0,0 +1,6 @@
+# 1.0.0
+
+- initial release 🎉
+  - includes coverage comparison
+  - `path` input override
+  - `min_coverage` threshold override

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 GitHub Actions
+Copyright (c) 2020 Very Good Ventures
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,116 +1,33 @@
-# Create a JavaScript Action
+# Very Good Coverage
 
-<p align="center">
-  <a href="https://github.com/actions/javascript-action/actions"><img alt="javscript-action status" src="https://github.com/actions/javascript-action/workflows/units-test/badge.svg"></a>
-</p>
+[![Very Good Ventures](https://raw.githubusercontent.com/VGVentures/very_good_analysis/main/assets/vgv_logo.png)](https://verygood.ventures)
 
-Use this template to bootstrap the creation of a JavaScript action.:rocket:
+Developed with 💙 by [Very Good Ventures](https://verygood.ventures) 🦄
 
-This template includes tests, linting, a validation workflow, publishing, and versioning guidance.
+[![units-test](https://github.com/VGVentures/very-good-coverage/workflows/units-test/badge.svg)](https://github.com/VGVentures/very_good_analysis/actions)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
+A Github Action which helps enforce a minimum code coverage threshold.
 
-## Create an action from this template
+## Inputs
 
-Click the `Use this Template` and provide the new repo details for your action
+### `path`
 
-## Code in Main
+**Optional** The path to the `lcov.info` file.
 
-Install the dependencies
+**Default** `./coverage/lcov.info`
 
-```bash
-npm install
-```
-
-Run the tests :heavy_check_mark:
-
-```bash
-$ npm test
-
- PASS  ./index.test.js
-  ✓ throws invalid number (3ms)
-  ✓ wait 500 ms (504ms)
-  ✓ test runs (95ms)
-...
-```
-
-## Change action.yml
-
-The action.yml contains defines the inputs and output for your action.
-
-Update the action.yml with your name, description, inputs and outputs for your action.
-
-See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
+### `min_coverage`
 
-## Change the Code
+**Optional** The minimum coverage percentage allowed.
 
-Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
+**Default** 100
 
-```javascript
-const core = require('@actions/core');
-...
-
-async function run() {
-  try {
-      ...
-  }
-  catch (error) {
-    core.setFailed(error.message);
-  }
-}
-
-run()
-```
-
-See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
-
-## Package for distribution
-
-GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.
-
-Actions are run from GitHub repos.  Packaging the action will create a packaged action in the dist folder.
-
-Run prepare
-
-```bash
-npm run prepare
-```
-
-Since the packaged index.js is run from the dist folder.
-
-```bash
-git add dist
-```
-
-## Create a release branch
-
-Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.
-
-Checkin to the v1 release branch
-
-```bash
-git checkout -b v1
-git commit -a -m "v1 release"
-```
-
-```bash
-git push origin v1
-```
-
-Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
-
-Your action is now published! :rocket:
-
-See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-
-## Usage
-
-You can now consume the action by referencing the v1 branch
+## Example usage
 
 ```yaml
-uses: actions/javascript-action@v1
+uses: VGVentures/very-good-coverage@v1.0.0
 with:
-  milliseconds: 1000
+  path: "./coverage/lcov.info"
+  min_coverage: 95
 ```
-
-See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "javascript-action",
+  "name": "very-good-coverage",
   "version": "1.0.0",
-  "description": "JavaScript Action Template",
+  "description": "A Github Action which helps enforce code coverage threshold using lcov",
   "main": "index.js",
   "scripts": {
     "lint": "eslint .",
@@ -11,19 +11,22 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/actions/javascript-action.git"
+    "url": "git+https://github.com/VGVentures/very-good-coverage.git"
   },
   "keywords": [
     "GitHub",
     "Actions",
-    "JavaScript"
+    "Coverage",
+    "JavaScript",
+    "lcov",
+    "testing"
   ],
-  "author": "",
+  "author": "[email protected]",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/actions/javascript-action/issues"
+    "url": "https://github.com/VGVentures/very-good-coverage/issues"
   },
-  "homepage": "https://github.com/actions/javascript-action#readme",
+  "homepage": "https://github.com/VGVentures/very-good-coverage",
   "dependencies": {
     "@actions/core": "^1.2.5",
     "lcov-parse": "^1.0.0"