From b7b680c4f1353400780aff7f0964124500ef7796 Mon Sep 17 00:00:00 2001 From: Luan Date: Fri, 13 Sep 2024 14:07:55 -0300 Subject: [PATCH] docs(examples): add instructions --- examples/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 examples/README.md diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..615724d --- /dev/null +++ b/examples/README.md @@ -0,0 +1,25 @@ +**NOTE:** +Build the library first before running the examples! + +```bash +npm run build +``` + +## Browser Example + +```bash +cd examples/browser/web +npm install +npm run dev + +# Proxy server +deno run --allow-net --allow-read examples/browser/proxy/deno.ts +``` + +## Downloader Example + +```bash +cd examples/downloader +npm install +npx tsx main.ts +``` \ No newline at end of file