Overhaul documentation

[Niek]

The README needs some updating to reflect the changes in the code recently:

• Example of installMouseHelper
• New function signature for createCursor
• New function signature for move and click
• Document moveTo and getRandomPagePoint

Anybody who's willing to check this?

[Niek]

Sample TS code:

import * as puppeteer from 'puppeteer'
import { createCursor, getRandomPagePoint, installMouseHelper } from 'ghost-cursor'

(async () => {
  const browser = await puppeteer.launch()
  const page = await browser.newPage()
  const cursor = createCursor(page, await getRandomPagePoint(page), true)
  await installMouseHelper(page) // this shows the trace
  page.goto('https://www.example.com/')
  await cursor.click('element', { waitForClick: 10000, waitForSelector: 1000, paddingPercentage: 20 })
})()

[Somberor]

@Niek how can the speed of the mouse movement be set? Sometimes it goes too fast and I would like it to have some minimum Thank you for the great implementation!

[Niek]

@Niek how can the speed of the mouse movement be set? Sometimes it goes too fast and I would like it to have some minimum Thank you for the great implementation!

This can be changed in the path() function - if you want to add speed customization, feel free to open a PR.

[clouedoc]

I'd like to add an item to the list:

• [ ] Document the fact that the cursor supports XPath

[TheGP]

I generated some docs with ChatGPT, wanna see what you'll think :)

[Niek]

Fixed in #116