Skip to content

Commit

Permalink
Added link to documentation; fix license link
Browse files Browse the repository at this point in the history
  • Loading branch information
darthcav committed May 11, 2024
1 parent 54eb754 commit 049977d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/jsdoc-to-gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,15 @@ jobs:
ref: gh-pages
repository: ${{ github.repository }}
token: ${{ github.token }}
- name: Clear existing content (optional)
run: rm -rf ./public # This will remove all existing files in the gh-pages branch
- name: Clear existing content (optional)
run: rm -rf ./docs # This will remove all existing files in the gh-pages branch
- name: Download artifact
uses: actions/[email protected]
with:
name: docs
path: ./docs
- name: Copy license
run: cp LICENSE ./docs/LICENSE
- name: Commit and push to gh-pages
run: |
git config user.name ${{ github.actor }}
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ test-containers

Wrapper around the dockerode library to manipulate Docker containers in NodeJS test environments.

## Documentation

The documentation is available at: [https://darthcav.github.io/test-containers/](https://darthcav.github.io/test-containers/).

## License

[Apache 2.0](LICENSE).

0 comments on commit 049977d

Please sign in to comment.