From commits-return-9930-apmail-couchdb-commits-archive=couchdb.apache.org@couchdb.apache.org Mon Feb 11 11:12:24 2013 Return-Path: X-Original-To: apmail-couchdb-commits-archive@www.apache.org Delivered-To: apmail-couchdb-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id B15E0E8B2 for ; Mon, 11 Feb 2013 11:12:24 +0000 (UTC) Received: (qmail 50905 invoked by uid 500); 11 Feb 2013 11:12:22 -0000 Delivered-To: apmail-couchdb-commits-archive@couchdb.apache.org Received: (qmail 50615 invoked by uid 500); 11 Feb 2013 11:12:21 -0000 Mailing-List: contact commits-help@couchdb.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@couchdb.apache.org Delivered-To: mailing list commits@couchdb.apache.org Received: (qmail 48339 invoked by uid 99); 11 Feb 2013 11:12:15 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 11 Feb 2013 11:12:15 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id D38C93C74A; Mon, 11 Feb 2013 11:12:14 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: jan@apache.org To: commits@couchdb.apache.org X-Mailer: ASF-Git Admin Mailer Subject: [29/50] [abbrv] git commit: add docs about settings.json in the addon walkthrough Message-Id: <20130211111214.D38C93C74A@tyr.zones.apache.org> Date: Mon, 11 Feb 2013 11:12:14 +0000 (UTC) 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