Skip to content

Commit

Permalink
feat(vx-marker): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hshoff committed Aug 19, 2020
1 parent c1865c7 commit 6ddbc2d
Showing 1 changed file with 2 additions and 18 deletions.
20 changes: 2 additions & 18 deletions packages/vx-marker/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,8 @@
<img src="https://img.shields.io/npm/dm/@vx/marker.svg?style=flat-square" />
</a>

A Marker is a line with a piece of text attached to it. It's great for highlighting locations in
your graph.

## Example

![marker example](http://i.imgur.com/vbW3Ysa.png)

```js
<Marker
from={markerFrom}
to={markerTo}
stroke={'white'}
label={'deploy'}
labelStroke={'none'}
labelDx={6}
labelDy={15}
/>
```
Markers are elements attached to shapes.
[MDN `<marker>`](https://developer.mozilla.org/en-US/docs/Web/SVG/Element/marker)

## Installation

Expand Down

0 comments on commit 6ddbc2d

Please sign in to comment.