From 049977d13c11dea0221294c10a7dca9a8a8df542 Mon Sep 17 00:00:00 2001
From: darthcav <darth.cav@gmail.com>
Date: Sat, 11 May 2024 09:39:14 +0200
Subject: [PATCH] Added link to documentation; fix license link

---
 .github/workflows/jsdoc-to-gh-pages.yml | 4 ++--
 README.md                               | 4 ++++
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/jsdoc-to-gh-pages.yml b/.github/workflows/jsdoc-to-gh-pages.yml
index 8a30ced..5b453b3 100644
--- a/.github/workflows/jsdoc-to-gh-pages.yml
+++ b/.github/workflows/jsdoc-to-gh-pages.yml
@@ -49,8 +49,6 @@ 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
@@ -58,6 +56,8 @@ jobs:
         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 }}
diff --git a/README.md b/README.md
index 81212ac..a916235 100644
--- a/README.md
+++ b/README.md
@@ -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).