Skip to content

Commit

Permalink
adding a simple readme with instructions for enabling plugins, relate…
Browse files Browse the repository at this point in the history
…d to #476
  • Loading branch information
henriyli committed Mar 9, 2016
1 parent 388320b commit cbe6f3a
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions plugins/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Place plugins here each one in it's own folder. The folder name will be used as the plugin name.
Include a file called plugin.json in the root of the plugin's folder e.g. 'Skosmos/plugins/myplugin/plugin.json'.
Below you will see a sample of what the plugin.json file could look like:
{
"js": ["someJavascript.js"],
"css": ["sampleStyles.css"],
"templates": ["template.html"]
}
The plugin.json tells Skosmos where it can find the files needed for your plugin.
Filenames should be strings in a javascript array. The above file tells Skosmos
to look for the plugin's js in 'Skosmos/plugins/myplugin/someJavascript.js'.

0 comments on commit cbe6f3a

Please sign in to comment.