docs: readme changes and misc other changes

README.md

@@ -2,6 +2,9 @@ Template from https://gist.github.com/jxson/1784669
 
 ## Synopsis
 
+[![Build Status](https://travis-ci.org/csprayca/superawesomebase.svg?branch=master)](https://travis-ci.org/csprayca/superawesomebase)
+[![Coverage Status](https://coveralls.io/repos/github/csprayca/superawesomebase/badge.svg?branch=master)](https://coveralls.io/github/csprayca/superawesomebase?branch=master)
+[![codecov](https://codecov.io/gh/csprayca/superawesomebase/branch/master/graph/badge.svg)](https://codecov.io/gh/csprayca/superawesomebase)
 [![Greenkeeper badge](https://badges.greenkeeper.io/csprayca/superawesomebase.svg)](https://greenkeeper.io/)
 
 At the top of the file there should be a short introduction and/ or overview that explains **what** the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
@@ -16,7 +19,48 @@ A short description of the motivation behind the creation and maintenance of the
 
 ## Installation
 
-Provide code examples and explanations of how to get the project.
+> Provide code examples and explanations of how to get the project.
+
+<!-- START: TRY 1 -->
+
+Here are some base required services that are super awesome for any project as a base. There are different pricing tier for a private projects vs. a public project.
+
+Unit tests are required at the minimum. Why? Your future self will thank you.
+
+### Travis CI
+
+- the quick and dirty software system that just works
+- use it to run our test suite
+- and use it to perform other automated duties upon test suite completion
+
+---
+
+- requirements (_must_):
+  - setup env variables: `CODECOV_TOKEN` and `GH_TOKEN`
+- `CODECOV_TOKEN` is found at `/settings` url of your project on codecov.io dashboard interface. For example, here is the link to mine: `https://codecov.io/gh/csprayca/superawesomebase/settings`
+- `GH_TOKEN` is generated from github. You can search for the tutorials here on github. For example, here is the link to mine: `https://github.com/settings/tokens`
+  - I highly recommend that you are selective in what permissions you give to what key
+  - For example, my keys are per project. This way if one key is compromised only one project is affected. Minimize your security risk and general penetration space.
+
+### Coveralls
+
+- used for visual inspection of test coverage
+- backup to codecov (if it is down or fails)
+- reports generated after a successful test suite
+- get your own badge. For example, mine is at `https://coveralls.io/github/csprayca/superawesomeredirector?branch=master`
+
+### Codecov
+
+- used for visual inspection of test coverage
+- backup to coveralls (if it is down or fails)
+- reports generated after a successful test suite
+- get your own badge from `/settings/badge`. For example, mine is: `https://codecov.io/gh/csprayca/superawesomebase/settings/badge`
+
+### Greenkeeper
+
+- used to keep project dependencies up to date
+- bot that is run whenever a npm dependency is updated
+- view dashboard with an individual status per project. For example, mine is: `https://account.greenkeeper.io/account/csprayca`
 
 ## API Reference
 

package.json

@@ -15,8 +15,7 @@
     "lint:fix": "eslint --fix src",
     "jsdoc": "jsdoc -c jsdoc.config.js",
     "semantic-release": "semantic-release",
-    "commit": "git-cz",
-    "corp-release": "corp-semantic-release"
+    "commit": "git-cz"
   },
   "config": {
     "commitizen": {
@@ -49,7 +48,6 @@
     "babel-jest": "^23.6.0",
     "codecov": "^3.1.0",
     "commitizen": "^3.0.5",
-    "corp-semantic-release": "^6.4.0",
     "coveralls": "^3.0.2",
     "cz-conventional-changelog": "^2.1.0",
     "eslint": "^5.9.0",

release.config.js

@@ -10,9 +10,8 @@ exports = module.exports = {
       '@semantic-release/git',
       {
         assets: ['CHANGELOG.md', 'package.json', 'package-lock.json'],
-        message: `chore(release): ${nextRelease.version} [skip ci]\n\n${
-          nextRelease.notes
-        }`
+        message:
+          'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}'
       }
     ]
   ]