diff --git a/README.md b/README.md index 99422e0..22e0348 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 diff --git a/package.yaml b/package.yaml index 535f69d..fd72d1f 100644 --- a/package.yaml +++ b/package.yaml @@ -1,8 +1,16 @@ name: cdp version: 0.0.1.0 -synopsis: Project synopsis -description: See README at +synopsis: A library for the Chrome Devtools Protocol (CDP) +description: + " + Chrome Devtools Protocol: https://chromedevtools.github.io/devtools-protocol/ + + README: + + Examples: + " author: Arsalan Cheema +maintainer: Arsalan Cheema github: arsalan0c/cdp-hs category: Package.Category license: BSD-3-Clause