diff --git a/README.md b/README.md index 3d155f6..619412c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ A Sphinx extension to embed website screenshots. +![Example screenshot](https://raw.githubusercontent.com/tushuhei/sphinxcontrib-screenshot/main/example.png) + ## Install ```bash @@ -38,12 +40,12 @@ You can include a caption for the screenshot's `figure` directive. :caption: This is a screenshot for www.example.com ``` -You can describe the interaction that you want to have with the webpage before taking a screenshot. `page` is the [Playwright's Page instance](https://playwright.dev/docs/api/class-page). +You can describe the interaction that you want to have with the webpage before taking a screenshot in JavaScript. ```rst .. screenshot:: http://www.example.com - page.get_by_role('link').click() + document.querySelector('button').click(); ``` diff --git a/example.png b/example.png new file mode 100644 index 0000000..229927d Binary files /dev/null and b/example.png differ