Skip to content

Commit

Permalink
update readme (#68)
Browse files Browse the repository at this point in the history
  • Loading branch information
arsalan0c authored Dec 19, 2022
1 parent 533546c commit f6db7a0
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 4 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@

A Haskell library for the [Chrome Devtools Protocol (CDP)](https://chromedevtools.github.io/devtools-protocol/), generated from the protocol's definition files.


## Quick start

`cdp` contains the generated library.
Expand Down Expand Up @@ -86,7 +85,17 @@ whileTrue f act = do
[Project board](https://github.com/users/arsalan0c/projects/1)

Commands and events for all non-deprecated domains are supported.
Session are supported as well and can be used to send commands to or listen for events from a specific target such as a tab.
The following session functionalities are supported:
- creating a session: obtain a session id by using the `pTargetAttachToTarget` function to send a `Target.attachToTarget` command, passing `True` for the flatten argument
- send a command for a particular session: use the `sendCommandForSession` function with a session id
- subscribe to events for a particular session:
1. register a handler with a session id
2. send the command to enable events for the domain, with the same session id

## Contributing

PRs are welcome! If you would like to discuss changes or have any feedback, feel free to open an [issue](https://github.com/arsalan0c/cdp-hs/issues).


## Acknowledgements

Expand Down
12 changes: 10 additions & 2 deletions package.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
name: cdp
version: 0.0.1.0
synopsis: Project synopsis
description: See README at <https://github.com/arsalan0c/cdp-hs>
synopsis: A library for the Chrome Devtools Protocol (CDP)
description:
"
Chrome Devtools Protocol: https://chromedevtools.github.io/devtools-protocol/
README: <https://github.com/arsalan0c/cdp-hs>
Examples: <https://github.com/arsalan0c/cdp-hs/examples>
"
author: Arsalan Cheema
maintainer: Arsalan Cheema
github: arsalan0c/cdp-hs
category: Package.Category
license: BSD-3-Clause
Expand Down

0 comments on commit f6db7a0

Please sign in to comment.