Skip to content

Commit 56005c7

Browse files
committed
docs: update README
1 parent b4572d8 commit 56005c7

File tree

1 file changed

+3
-12
lines changed

1 file changed

+3
-12
lines changed

README.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,7 @@ yarn add @lycorp-jp/tappy puppeteer
1818
pnpm add @lycorp-jp/tappy puppeteer
1919
```
2020

21-
> **Note**: Puppeteer is a peer dependency. You need to install it separately.
22-
23-
## Examples
21+
## Usage
2422

2523
```typescript
2624
import { type Device, Tappy } from "@lycorp-jp/tappy";
@@ -45,7 +43,7 @@ const device: Device = {
4543
const result = await tappy.analyze("https://example.com", device);
4644

4745
console.log(result.elements);
48-
// This contains information about all analyzed tappable elements
46+
4947
// Example output:
5048
// [
5149
// {
@@ -60,11 +58,4 @@ console.log(result.elements);
6058
await browser.close();
6159
```
6260

63-
Check out the [examples](./examples) directory for other usage:
64-
65-
- [Visualization](./examples/visualization.ts)
66-
67-
## Requirements
68-
69-
- Node.js 20 or higher
70-
- Puppeteer (currently the only supported browser adapter)
61+
Check out the [examples](./examples) directory for other usage

0 commit comments

Comments
 (0)