diff --git a/README.md b/README.md index c4ac273..16a753f 100644 --- a/README.md +++ b/README.md @@ -131,6 +131,23 @@ Contributing If you would like to contribute source code and/or documentation changes please [read contributing.md][contrib] +Configuration +============= +ScriptCraft is a Bukkit Plugin and uses the Bukkit Configuration +API. On first loading, ScriptCraft will create a config.yml file in +the plugins/scriptcraft/ directory. This file looks like this... + + extract-js: + plugins: true + modules: true + lib: true + +This file allows scriptcraft admins to turn on or off re-unzipping of the `modules`, +`plugins` and `lib` folders when deploying a new version of +scriptcraft. It's strongly recommended that the `lib` directory always +be set to true to get the latest core scriptcraft code . The modules +and plugins directories are optional and not part of scriptcraft core. + Further Reading =============== diff --git a/docs/release-notes.md b/docs/release-notes.md index 1232275..0fd0184 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -1,3 +1,18 @@ +# 2014 01 14 + +Added config.yml file for configuration options. This file allows +scriptcraft admins to turn on or off re-unzipping of the modules, +plugins and lib folders when deploying a new version of +scriptcraft. It's strongly recommended that the lib directory always +be set to true to get the latest core scriptcraft code . The modules +and plugins directories are optional and not part of scriptcraft core. +The config.yml file looks like this... + + extract-js: + plugins: true + modules: true + lib: true + # 2014 01 13 Bug Fix: Make ScriptCraft work with Nashorn javascript engine bundled with Java 8