Skip to content

Commit

Permalink
update readme with more devops
Browse files Browse the repository at this point in the history
  • Loading branch information
Granitosaurus committed Jul 28, 2024
1 parent a41305b commit 2ce9244
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ The SDK is distributed through:
3. Start scraping: 🚀

```javascript
// node or bun:
import { ScrapflyClient, ScrapeConfig } from 'scrapfly-sdk';
// deno:
import { ScrapflyClient, ScrapeConfig } from 'jsr:@scrapfly/scrapfly-sdk';

const key = 'YOUR SCRAPFLY KEY';
const client = new ScrapflyClient({ key });
Expand Down Expand Up @@ -82,13 +85,19 @@ This is a Deno Typescript project that builds to NPM through [DNT](https://githu
- `__tests__` directory contains tests for the source code.
- `deno.json` contains meta information
- `build.ts` is the build script that builds the project to nodejs ESM package.
- `/npm` directory will be produced when `buil.ts` is executed for building node package.
- `/npm` directory will be produced when `built.ts` is executed for building node package.

```bash
# make modifications and run tests
$ deno task test
# format
$ deno fmt
# lint
$ deno linst
$ deno lint
# publish jsr:
$ deno publish
# build NPM package:
$ deno run -A build.ts
# publish NPM:
$ cd npm && npm publish
```

0 comments on commit 2ce9244

Please sign in to comment.