docs: add link to ts declaration file

grafana · Feb 22, 2024 · 445c9c0 · 445c9c0
1 parent 5e13a0e
commit 445c9c0
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 3 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -28,8 +28,6 @@ jobs:
         run: bun x typedoc
       - name: Copy index.d.ts
         run: cp index.d.ts build/docs/
-      - name: Copy index.js
-        run: cp index.js build/docs/
 
       - name: Setup Pages
         uses: actions/configure-pages@v4

diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ Altought there is several good JavaScript fake data generator, but using these a
 
 For convenience, the xk6-faker API resembles the popular [Faker.js](https://fakerjs.dev/) API as much as possible. Random data of the same type can be generated in the same way. A subset of the [Faker.js](https://fakerjs.dev/) API has been implemented in a simplified form.
 
-Check out the API documentation [here](https://ivan.szkiba.hu/xk6-faker).
+Check out the API documentation [here](https://ivan.szkiba.hu/xk6-faker). The TypeScript declaration file can be downloaded from [here](https://ivan.szkiba.hu/xk6-faker/index.d.ts).
 
 **Example**