Skip to content

Commit

Permalink
docs: improve the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gajus committed Jan 17, 2017
1 parent c545719 commit e98037d
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,21 @@

DOM extraction expression evaluator.

* Supports [selector nesting](#nest-the-selectors)
* Integrates [match validation](#validate-the-result)
* Works in Node.js or in browser.
* Uses domain-specific language (DSL) to:
* select a defined number of nodes ([Quantifier expression](#quantifier-expression))
* select a single node out of a matching list of nodes ([Accessor expression](#accessor-expression))
* access [attribute](#attribute-selector) and [property](#property-selector) values

Have you got suggestions for improvement? [I am all ears](https://github.com/gajus/surgeon/issues).

---

* [Configuration](#configuration)
* [Cookbook](#cookbook)
* [Extract single node](#extract-single-node)
* [Extract a single node](#extract-a-single-node)
* [Extract multiple nodes](#extract-multiple-nodes)
* [Nest the selectors](#nest-the-selectors)
* [Validate the result](#validate-the-result)
Expand Down Expand Up @@ -50,7 +62,7 @@ const x = surgeon();
>
> For simplicity, strict-equal operator (`===`) is being used to demonstrate deep equality.
### Extract single node
### Extract a single node

The default behaviour of a query is to match a single node and extract value of the `textContent` property.

Expand Down

0 comments on commit e98037d

Please sign in to comment.