소스 검색

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
+```