Instructions for setting defaults added. Package.json description added

sir-dunxalot · May 21, 2016 · c67e0ac · c67e0ac
1 parent e93c164
commit c67e0ac
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@ Documentation for usage is below:
   - [tooltip-on-component](#tooltip-on-component)
   - [tooltip-on-element](#tooltip-on-element)
 - [Options](#options)
+  - [Setting defaults](#setting-defaults)
 - [Actions](#actions)
 - [Accessibility](#accessibility)
 
@@ -314,6 +315,21 @@ This can be useful alongside `event='none'` when you only want to toolip to show
 {{tooltip-on-component tooltipIsVisible=showTooltip}}
 ```
 
+### Setting Defaults
+
+You can set the default for any option by extending the `{{tooltip-on-element}}` component:
+
+```js
+{{!--your-app/components/tooltip-on-element}}--}}
+
+import TooltipOnElementComponent from 'ember-tooltips/components/tooltip-on-element';
+
+export default TooltipOnElementComponent.extend({
+  effect: 'fade',
+  side: 'bottom',
+});
+```
+
 ## Actions
 
 Four actions are available for you to hook onto through the tooltip lifecycle:

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "ember-tooltips",
   "version": "1.0.0",
-  "description": "The default blueprint for ember-cli addons.",
+  "description": "Easy and extendible tooltips for Ember",
   "directories": {
     "doc": "doc",
     "test": "tests"