add docs about settings.json in the addon walkthrough Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/73e69b32 Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/73e69b32 Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/73e69b32 Branch: refs/heads/fauxton Commit: 73e69b320332449f05ba8c70acf5bcf4472e99a3 Parents: 37e184f Author: Simon Metson Authored: Sun Jan 27 20:15:05 2013 +0100 Committer: Simon Metson Committed: Sun Jan 27 20:15:49 2013 +0100 ---------------------------------------------------------------------- src/fauxton/writing_addons.md | 9 +++++++++ 1 files changed, 9 insertions(+), 0 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb/blob/73e69b32/src/fauxton/writing_addons.md ---------------------------------------------------------------------- diff --git a/src/fauxton/writing_addons.md b/src/fauxton/writing_addons.md index 6e83966..a41af53 100644 --- a/src/fauxton/writing_addons.md +++ b/src/fauxton/writing_addons.md @@ -144,3 +144,12 @@ Then wire it all together in base.js: console.log(Hello); return Hello; }); + +Once the code is in place include the add on in your `settings.json` so that it +gets included by the `require` task. Your addon is included in one of three +ways; a local path, a git URL or a name. Named plugins assume the plugin is in +the fauxton base directory, addons with a git URL will be cloned into the +application, local paths will be copied. Addons included from a local path will +be cleaned out by the clean task, others are left alone. + +**TODO:** addons via npm module