docs(README): add changelog link (#63)

Author: giladgd

.github/workflows/build.yml

@@ -223,6 +223,8 @@ jobs:
       - build-binaries
     steps:
       - uses: actions/checkout@v3
+        with:
+          lfs: true
       - uses: actions/setup-node@v3
         with:
           node-version: "20"
@@ -260,7 +262,7 @@ jobs:
           if [ -f .semanticRelease.npmPackage.deployedVersion.txt ]; then
             echo "npm-url=https://www.npmjs.com/package/node-llama-cpp/v/$(cat .semanticRelease.npmPackage.deployedVersion.txt)" >> $GITHUB_OUTPUT
           fi
-      - name: Generate docs
+      - name: Generate docs with updated version
         if: steps.set-npm-url.outputs.npm-url != ''
         env:
           DOCS_URL_BASE: "/node-llama-cpp/"

.github/workflows/test.yml

@@ -15,3 +15,18 @@ jobs:
         run: npx eslint --ext .js --ext .ts .
       - name: TypeScript validity
         run: npm run test:typescript
+
+  compile-docs:
+    name: Test docs compilation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          lfs: true
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+      - name: Install modules
+        run: npm ci
+      - name: Compile docs
+        run: npm run docs:build

README.md

@@ -28,6 +28,7 @@
 * [Getting started guide](https://withcatai.github.io/node-llama-cpp/guide/)
 * [API reference](https://withcatai.github.io/node-llama-cpp/api/classes/LlamaModel)
 * [CLI help](https://withcatai.github.io/node-llama-cpp/guide/cli/)
+* [Changelog](https://github.com/withcatai/node-llama-cpp/releases)
 
 ## Installation
 ```bash