浏览代码

docs: add instructions to run examples (#45)

Cheong Yip 1 年之前
父节点
当前提交
8983eb52fd
共有 1 个文件被更改,包括 11 次插入0 次删除
  1. 11 0
      README.md

+ 11 - 0
README.md

@@ -205,3 +205,14 @@ To build the project files run:
 ```sh
 npm run build
 ```
+
+## Examples
+
+> [!IMPORTANT]
+> Note: Ensure that `npm build` has been run before running the examples.
+
+To run the examples run:
+
+```sh
+npx tsx examples/<folder-name>/<file-name>.ts
+```