Skip to content

Commit

Permalink
small updates to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nvdk committed Apr 23, 2018
1 parent 8fa0c84 commit bc954f4
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,25 @@ This package assumes you follow these conventions:
Usage:
------------------------------------------------------------------------------
```
#create an addon
# create an addon
ember addon ember-rdfa-editor-your-name-plugin
# add the package scope to index.js and package.json
emacs
# install this addon
ember install @lblod/ember-rdfa-editor-plugin-generator
# generate the plugin scaffold
ember g editor-plugin your-name
```

The following generated files should be modified to your liking:

`blueprints/@lblod/ember-rdfa-editor-your-name-plugin/index.js`
### `blueprints/@lblod/ember-rdfa-editor-your-name-plugin/index.js`
This is a default blueprint which will add your plugin to the configured profile when it's installed

`addon/services/rdfa-editor-my-test-plugin.js`
### `addon/services/rdfa-editor-my-test-plugin.js`
The service providing hints to the editor, the execute task will be called when the content of the editor is updated.

`addon/components/editor-plugins/my-test-card.js` and `addon/templates/components/editor-plugins/my-test-card.hbs`
### `addon/components/editor-plugins/my-test-card.js` and `addon/templates/components/editor-plugins/my-test-card.hbs`
These components handle the display of hints and perform the necessary actions when they are triggered (eg applying the hint in the editor)

Contributing
Expand Down

0 comments on commit bc954f4

Please sign in to comment.