Skip to content

Commit

Permalink
Merge pull request slamdata#11 from srghma/master
Browse files Browse the repository at this point in the history
feat: update readme
  • Loading branch information
cryogenian authored Nov 13, 2020
2 parents 3e02612 + 7db1433 commit 0e29451
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ won't involve any JavaScript dependencies.
+ There is a module that encodes any possible error returned by Selenium.
+ Low-level API uses `purescript-argonaut`'s `Json` type and `purescript-affjax`s helper functions (`get`, `post` etc)
+ Endpoints are constructed using `[email protected]` type. This module also provides helper functions
returning `Aff _ (Either Error Json)`
returning `Aff (Either Error Json)`
+ Types of requests and resposes live in `Lunapark.Types` module.
+ High-level API uses `purescript-run`. There are several functors, but the main two are: `LunaparkF` and `ActionF`.
This functor embed in `Run` encode almost all posible interactions with w3c/selenium server.
Expand All @@ -26,7 +26,7 @@ This functor embed in `Run` encode almost all posible interactions with w3c/sele
+ `Lunapark` is facade library on top of api, functors and error.
+ Capabilities are represented via gradually typed datastructure `Array Capability`. `init` function takes a record
`{ alwaysMatch: Array Capability, firstMatch: Array (Array Capability) }`. `firstMatch` must have at least on array.
+ To construct interpreter you need call `[email protected]`. The result would be `Aff _ (Either Error Interpreter)`,
+ To construct interpreter you need call `[email protected]`. The result would be `Aff (Either Error Interpreter)`,
where `Interpreter` is function taking `Lunapark` monad and unwrapping it into `Run` with `EXCEPT` and `AFF|EFF`. E.g.

```purescript
Expand Down

0 comments on commit 0e29451

Please sign in to comment.