Merge 469c775 into 86bfaac

README.md

@@ -1,29 +1,84 @@
 <p align="center">
-  <a href="https://github.com/Kibibit/project-template" target="blank"><img src="<link to image>" width="150" ></a>
+  <a href="https://github.com/Kibibit/test-report-now" target="blank"><img src="./scooter.svg" width="150" ></a>
   <h2 align="center">
-    @kibibit/project-template
+    @kibibit/test-report-now
   </h2>
 </p>
 <p align="center">
-  <a href="https://www.npmjs.com/package/@kibibit/announce-it"><img src="https://img.shields.io/npm/v/@kibibit/announce-it/latest.svg?style=for-the-badge&logo=npm&color=CB3837"></a>
+  <a href="https://www.npmjs.com/package/@kibibit/test-report-now"><img src="https://img.shields.io/npm/v/@kibibit/test-report-now/latest.svg?style=for-the-badge&logo=npm&color=CB3837"></a>
 </p>
 <p align="center">
-  <a href="https://www.npmjs.com/package/@kibibit/announce-it"><img src="https://img.shields.io/npm/v/@kibibit/announce-it/next.svg?style=flat-square&logo=npm&color=CB3837"></a>
-  <a href="https://travis-ci.org/Kibibit/announce-it">
-  <img src="https://travis-ci.org/Kibibit/announce-it.svg?branch=master">
+  <a href="https://www.npmjs.com/package/@kibibit/test-report-now"><img src="https://img.shields.io/npm/v/@kibibit/test-report-now/next.svg?style=flat-square&logo=npm&color=CB3837"></a>
+  <a href="https://travis-ci.org/Kibibit/test-report-now">
+  <img src="https://travis-ci.org/Kibibit/test-report-now.svg?branch=master">
   </a>
-  <a href="https://coveralls.io/github/Kibibit/announce-it?branch=master">
-  <img src="https://coveralls.io/repos/github/Kibibit/announce-it/badge.svg?branch=master">
+  <a href="https://coveralls.io/github/Kibibit/test-report-now?branch=master">
+  <img src="https://coveralls.io/repos/github/Kibibit/test-report-now/badge.svg?branch=master">
   </a>
   <a href="http://greenkeeper.io">
-    <img src="https://badges.greenkeeper.io/Kibibit/announce-it.svg">
+    <img src="https://badges.greenkeeper.io/Kibibit/test-report-now.svg">
   </a>
   <a href="https://salt.bountysource.com/teams/kibibit"><img src="https://img.shields.io/endpoint.svg?url=https://monthly-salt.now.sh/kibibit&style=flat-square"></a>
 </p>
 <p align="center">
-  <!-- PUNCH LINE -->PUNCH LINE
+  Deploy test result report to zeit now
 </p>
 <hr>
 
-<!-- GENERAL DESCRIPTION IF NEEDED -->
-GENERAL DESCRIPTION IF NEEDED
+This is going to change to push the test report to a github repo instead (since there's a limit on deployment time on zeit now)
+
+## how to use
+
+### Installation
+
+```bash
+$ npm install --save @kibibit/test-report-now
+```
+
+### Usage
+
+add to your `package.json` a new script:
+
+```json
+"scripts": {
+  "deploy-tests-report": "kb-reporter"
+}
+```
+
+and run on travis. This will not be coupled to travis later on
+
+### Test
+
+```bash
+# unit tests
+$ npm run test
+
+# e2e tests
+$ npm run test:e2e
+
+# test coverage
+$ npm run test:cov
+```
+
+## Stay in touch
+
+- Author - [Neil Kalman](https://github.com/thatkookooguy)
+
+## Contributors
+
+Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for [contributing](CONTRIBUTING.MD).
+
+You can check out some easy to start with issues in the [Easy Pick](https://github.com/Kibibit/kb-hologram/labels/Easy%20Pick).
+
+## Contributor Code of Conduct
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
+
+By participating in this project you agree to abide by its terms.
+
+## License
+
+[MIT License](LICENSE)
+
+Copyright (c) 2020 Neil Kalman &lt;neilkalman@gmail.com&gt;
+
+<div>Icons made by <a href="https://www.flaticon.com/authors/freepik" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div>

package.json

@@ -1,12 +1,13 @@
 {
   "name": "@kibibit/test-report-now",
-  "version": "1.0.0",
+  "version": "1.0.0-next.2",
   "description": "deploy test results to zeit-now and add a comment on PRs",
   "types": "lib/report-deployer.d.ts",
   "main": "lib/report-deployer.js",
   "files": [
     "/lib",
-    "/bin"
+    "/bin",
+    "scooter.svg"
   ],
   "bin": {
     "kb-reporter": "lib/test-report-cli.js"
@@ -31,7 +32,7 @@
     "url": "https://github.com/Kibibit/test-report-now.git"
   },
   "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/Kibibit/test-report-now/issues"
   },
@@ -59,7 +60,7 @@
     "@types/fs-extra": "^8.0.1",
     "@types/lodash": "^4.14.149",
     "@types/moment": "^2.13.0",
-    "@types/node": "^12.7.5",
+    "@types/node": "^13.1.0",
     "barrelsby": "^2.2.0",
     "commitizen": "^4.0.3",
     "coveralls": "^3.0.9",