Skip to content

Commit

Permalink
fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
sgratzl committed Jul 10, 2020
1 parent 66c4cc0 commit 6e17db5
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,27 +71,29 @@ cy.ready(() => {
});
```

````
## API

- `addPath(nodes: NodeCollection, edges: EdgeCollection | null, avoidNodes: NodeCollection | null, options?: IBubbleSetPathOptions): BubbleSetPath`
- `addPath(nodes: NodeCollection, edges?: EdgeCollection | null, avoidNodes?: NodeCollection | null, options?: IBubbleSetPathOptions): BubbleSetPath`

creates a new `BubbleSetPath` instance. The `nodes` is a node collection that should be linked. `edges` an edge collection to include edges. `avoidNodes` is an optional node collection of nodes that should be avoided when generating the outline and any virtual edge between the nodes.

- `removePath(path: BubbleSetPath)`

removes a path again

- `getPaths(): readonly BubbleSetPath[]`

returns the list of active paths

## Development Environment

```sh
npm i -g yarn
yarn set version 2
yarn set version latest
cat .yarnrc_patch.yml >> .yarnrc.yml
yarn
yarn pnpify --sdk
````
yarn pnpify --sdk vscode
```

### Common commands

Expand Down

0 comments on commit 6e17db5

Please sign in to comment.