From 66da917aa810af8a6cb2d7917d31f531734f86f6 Mon Sep 17 00:00:00 2001 From: syropian Date: Fri, 8 Feb 2019 15:31:58 -0500 Subject: [PATCH] Updates README regarding custom events --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index df45de1..890ce8e 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,26 @@ See the available Tribute options [here](https://github.com/zurb/tribute#a-colle ## Events -Tribute broadcasts two events — a `tribute-replaced` event, and a `tribute-no-match` event (see docs [here](https://github.com/zurb/tribute#replace-event)). For your convenience, whenever Tribute triggers these events, the vue-tribute component also [emits](http://vuejs.org/api/#vm-emit) these events. +Tribute broadcasts two events — a `tribute-replaced` event, and a `tribute-no-match` event (see docs [here](https://github.com/zurb/tribute#replace-event)). Listeners for these events can be attached directly to the child element of the `` component. Eg: + +```html + + + +``` + +## Development + +```bash +# To run the example +$ npm run example + +# To run the tests +$ npm test + +# To publish the dist file +$ npm run build +``` ## License