Skip to content
This repository was archived by the owner on Aug 4, 2020. It is now read-only.

Commit e7eeb07

Browse files
committed
docs: readme changes and misc other changes
1 parent ad7fc22 commit e7eeb07

File tree

4 files changed

+49
-8
lines changed

4 files changed

+49
-8
lines changed

README.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ Template from https://gist.github.com/jxson/1784669
22

33
## Synopsis
44

5+
[![Build Status](https://travis-ci.org/csprayca/superawesomebase.svg?branch=master)](https://travis-ci.org/csprayca/superawesomebase)
6+
[![Coverage Status](https://coveralls.io/repos/github/csprayca/superawesomebase/badge.svg?branch=master)](https://coveralls.io/github/csprayca/superawesomebase?branch=master)
7+
[![codecov](https://codecov.io/gh/csprayca/superawesomebase/branch/master/graph/badge.svg)](https://codecov.io/gh/csprayca/superawesomebase)
58
[![Greenkeeper badge](https://badges.greenkeeper.io/csprayca/superawesomebase.svg)](https://greenkeeper.io/)
69

710
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
1619

1720
## Installation
1821

19-
Provide code examples and explanations of how to get the project.
22+
> Provide code examples and explanations of how to get the project.
23+
24+
<!-- START: TRY 1 -->
25+
26+
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.
27+
28+
Unit tests are required at the minimum. Why? Your future self will thank you.
29+
30+
### Travis CI
31+
32+
- the quick and dirty software system that just works
33+
- use it to run our test suite
34+
- and use it to perform other automated duties upon test suite completion
35+
36+
---
37+
38+
- requirements (_must_):
39+
- setup env variables: `CODECOV_TOKEN` and `GH_TOKEN`
40+
- `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`
41+
- `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`
42+
- I highly recommend that you are selective in what permissions you give to what key
43+
- 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.
44+
45+
### Coveralls
46+
47+
- used for visual inspection of test coverage
48+
- backup to codecov (if it is down or fails)
49+
- reports generated after a successful test suite
50+
- get your own badge. For example, mine is at `https://coveralls.io/github/csprayca/superawesomeredirector?branch=master`
51+
52+
### Codecov
53+
54+
- used for visual inspection of test coverage
55+
- backup to coveralls (if it is down or fails)
56+
- reports generated after a successful test suite
57+
- get your own badge from `/settings/badge`. For example, mine is: `https://codecov.io/gh/csprayca/superawesomebase/settings/badge`
58+
59+
### Greenkeeper
60+
61+
- used to keep project dependencies up to date
62+
- bot that is run whenever a npm dependency is updated
63+
- view dashboard with an individual status per project. For example, mine is: `https://account.greenkeeper.io/account/csprayca`
2064

2165
## API Reference
2266

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@
1515
"lint:fix": "eslint --fix src",
1616
"jsdoc": "jsdoc -c jsdoc.config.js",
1717
"semantic-release": "semantic-release",
18-
"commit": "git-cz",
19-
"corp-release": "corp-semantic-release"
18+
"commit": "git-cz"
2019
},
2120
"config": {
2221
"commitizen": {
@@ -49,7 +48,6 @@
4948
"babel-jest": "^23.6.0",
5049
"codecov": "^3.1.0",
5150
"commitizen": "^3.0.5",
52-
"corp-semantic-release": "^6.4.0",
5351
"coveralls": "^3.0.2",
5452
"cz-conventional-changelog": "^2.1.0",
5553
"eslint": "^5.9.0",

release.config.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,8 @@ exports = module.exports = {
1010
'@semantic-release/git',
1111
{
1212
assets: ['CHANGELOG.md', 'package.json', 'package-lock.json'],
13-
message: `chore(release): ${nextRelease.version} [skip ci]\n\n${
14-
nextRelease.notes
15-
}`
13+
message:
14+
'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}'
1615
}
1716
]
1817
]

0 commit comments

Comments
 (0)