aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Merwin <[email protected]>2020-04-24 16:26:25 -0700
committerNick Merwin <[email protected]>2020-04-24 16:26:25 -0700
commit55c64cbe3f5f0a44d8bbdad337b373895d0997fe (patch)
tree30dd93e22e9f5a905b2a60a308782fb60cee978d
parent536f3c2bfeb4847f52b03130f4cd41cab92e3c6e (diff)
downloadnode-coveralls-55c64cbe3f5f0a44d8bbdad337b373895d0997fe.tar.xz
node-coveralls-55c64cbe3f5f0a44d8bbdad337b373895d0997fe.zip
update README with links to demo repo
-rw-r--r--README.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/README.md b/README.md
index d567ce0..0015654 100644
--- a/README.md
+++ b/README.md
@@ -39,23 +39,23 @@ There are optional environment variables for other build systems as well:
- `COVERALLS_SERVICE_JOB_ID` (an id that uniquely identifies the build's job)
- `COVERALLS_SERVICE_JOB_NUMBER` (a number that uniquely identifies the build's job)
- `COVERALLS_RUN_AT` (a date string for the time that the job ran. RFC 3339 dates work. This defaults to your build system's date/time if you don't set it.)
-- `COVERALLS_PARALLEL` (more info here: <https://docs.coveralls.io/parallel-build-webhook>)
+- `COVERALLS_PARALLEL` (set true when running jobs in parallel, requires a completion webhook. More info here: <https://docs.coveralls.io/parallel-build-webhook>)
### GitHub Actions CI
If you are using GitHub Actions CI, you should look into [coverallsapp/github-action](https://github.com/coverallsapp/github-action).
-If you prefer to use this package you can do it like this:
-
-```yml
-env:
- COVERALLS_REPO_TOKEN: "${{ secrets.COVERALLS_REPO_TOKEN }}"
- COVERALLS_GIT_BRANCH: "${{ github.ref }}"
-```
+Parallel runs example [workflow.yml](https://github.com/coverallsapp/coveralls-node-demo/blob/master/.github/workflows/workflow.yml)
### [CircleCI Orb](https://circleci.com)
-See our Orb here for quick integration: [coveralls/coveralls](https://circleci.com/orbs/registry/orb/coveralls/coveralls)
+Here's our Orb here for quick integration: [coveralls/coveralls](https://circleci.com/orbs/registry/orb/coveralls/coveralls)
+
+Workflow example: [config.yml](https://github.com/coverallsapp/coveralls-node-demo/blob/master/.circleci/config.yml)
+
+### [Travis-CI](https://travis-ci.org)
+
+Parallel jobs example: [.travis.yml](https://github.com/coverallsapp/coveralls-node-demo/blob/master/.travis.yml)
### [Jest](https://jestjs.io/)