fix doc, fixed #103

cnpm · Dec 18, 2013 · bda6fa7 · bda6fa7 · alsotang · Dec 19, 2013
1 parent b346139
commit bda6fa7
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/docs/web/install.md b/docs/web/install.md
@@ -46,10 +46,12 @@ module.exports = {
     bucket: "foobucket",
     domain: "http://foobucket.u.qiniudn.com"
   },
+  nfs: null, // you can set a nfs to replace qiniu cdn
   enablePrivate: true, // enable private mode, only admin can publish, other use just can sync package from source npm
   admins: {
-    admin: true,
+    admin: 'admin@cnpmjs.org',
   },
+  syncModel: 'exist', //`all` sync all packages, `exist` only update  exist packages, `none` do nothing
 };
 ```
 
@@ -62,6 +64,9 @@ mysql> use cnpmjs;
 mysql> source docs/db.sql
 ```
 
+## Use your own CDN
+If you wan to use your own CDN instead of qiniu. Just look at `common/qnfs.js` and implement the interface like it, then pass it by set `config.nfs`.
+
 ## npm install
 
 ```bash

diff --git a/docs/web/readme.md b/docs/web/readme.md
@@ -119,11 +119,14 @@ $(function () {
 alias it:
 
 ```bash
-alias cnpm="npm --registry=http://registry.cnpmjs.org --cache=$HOME/.npm/.cache/cnpm"
+alias cnpm="npm --registry=http://registry.cnpmjs.org \
+--cache=$HOME/.npm/.cache/cnpm \
+--userconfig=$HOME/.cnpmrc"
 
 #Or alias it in .bashrc or .zshrc
 $ echo '\n#alias for cnpm\nalias cnpm="npm --registry=http://registry.cnpmjs.org \
-  --cache=$HOME/.npm/.cache/cnpm"' >> ~/.zshrc && source ~/.zshrc
+  --cache=$HOME/.npm/.cache/cnpm \
+  --userconfig=$HOME/.cnpmrc"' >> ~/.zshrc && source ~/.zshrc
 ```
 
 Or you can just use our `cnpm` cli: