diff --git a/README.md b/README.md index bb5501e..a0b54db 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,14 @@ you want. config.json instructs plugin loader which files to load. Currently we Everytime you want to access local plugin files in javascript, css or wherever, you prepend `$LOCATION$/` to the url. The plugin server takes care, that correct url is generated. This settings is found in `URL` value in server python code. +In order for a plugin to work, javascript should export three function: + +```js +plugin_init(div, entry) +plugin_render(div, entry) +plugin_save(div) +``` + # Usage To use it, you must first paste the [javascript loader](plugin-loader.js) into custom entry editor section of Lexonomy configuration.