groom the README
This commit is contained in:
parent
f56d57d8dd
commit
c4e0f37aec
10
README.mkd
10
README.mkd
@ -1,7 +1,7 @@
|
|||||||
# vue-svg-pan-zoom : Vue component for SVG-Pan-Zoom
|
# vue-svg-pan-zoom : Vue component for SVG-Pan-Zoom
|
||||||
|
|
||||||
This module is a very simple [Vue][] component providing the
|
This module is a very simple [Vue][https://vuejs.org/] component providing the
|
||||||
goodness of [SVG-Pan-Zoom][] for SVG elements.
|
goodness of [SVG-Pan-Zoom][https://github.com/ariutta/svg-pan-zoom] for SVG elements.
|
||||||
|
|
||||||
/!\ WARNING: the module is young, basic, probably will have its
|
/!\ WARNING: the module is young, basic, probably will have its
|
||||||
API change with no notice, and likely to have
|
API change with no notice, and likely to have
|
||||||
@ -96,14 +96,12 @@ Note that for the css import to work, you'll have to have
|
|||||||
[postcss-import](https://github.com/postcss/postcss-import)
|
[postcss-import](https://github.com/postcss/postcss-import)
|
||||||
installed as a dep.
|
installed as a dep.
|
||||||
|
|
||||||
### Notes
|
Also, just like the main `SvgPanZoom`component, the `thumbnail` slot needs to
|
||||||
|
|
||||||
* Just like the main `SvgPanZoom`component, the `thumbnail` slot needs to
|
|
||||||
be assigned to a `svg` node -- `embed` won't work.
|
be assigned to a `svg` node -- `embed` won't work.
|
||||||
|
|
||||||
### Storybook demos
|
### Storybook demos
|
||||||
|
|
||||||
To run [Storybook][https://github.com/storybooks/storybook] stories duplicating the demos of
|
To run [Storybook](https://github.com/storybooks/storybook) stories duplicating the demos of
|
||||||
the main `SVG-Pan-Zoom` project, do
|
the main `SVG-Pan-Zoom` project, do
|
||||||
|
|
||||||
$ yarn install --dev
|
$ yarn install --dev
|
||||||
|
Loading…
Reference in New Issue
Block a user