update readme

cnpm · Aug 9, 2014 · 173d655 · 173d655
1 parent 1e8bbaa
commit 173d655
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -30,11 +30,11 @@ $ npm install fs-cnpm
 
 All the APIs are following [cnpm nfs guide](https://github.com/cnpm/cnpmjs.org/wiki/NFS-Guide).
 
-- `uploadBuffer`
+- `uploadBuffer`: upload a file
 
-- `download`
+- `download`: download file by key
 
-- `remove`
+- `remove`: remove file by key
 
 ### License
 

diff --git a/index.js b/index.js
@@ -48,6 +48,10 @@ Client.prototype.remove = function* (key) {
   yield fs.unlink(filepath);
 };
 
+/**
+ * escape '/' and '\'
+ */
+
 Client.prototype._getpath = function (key) {
   key = key.replace(/\//g, '-').replace(/\\/g, '_');
   return path.join(this.dir, key);