updates docs and examples

gabrielcsapo · gabrielcsapo · commit 3a1ebb29c895 · 2017-10-12T22:10:09.000-07:00
diff --git a/README.md b/README.md
@@ -10,25 +10,23 @@
 [![npm](https://img.shields.io/npm/dt/node-git-server.svg)]()
 [![npm](https://img.shields.io/npm/dm/node-git-server.svg)]()
 
-This library makes it super easy to set up custom git push deploy logic.
-
-# requirements
-
-```
-- git (^ 2.7)
-```
-
-# install
+# Install
 
 ```
 npm install node-git-server
 ```
 
-# example
+# Usage
 
 ```javascript
 const Server = require('node-git-server');
-const repos = Server('/tmp/repos');
+const repo = new Server(path.resolve(__dirname, 'tmp'), {
+    autoCreate: true,
+    authenticate: (type, repo, username, password, next) => {
+      console.log(type, repo, username, password);
+      next();
+    }
+});
 const port = process.env.PORT || 7005;
 
 repos.on('push', (push) => {
@@ -67,6 +65,8 @@ To http://localhost:7005/beep
  * [new branch]      master -> master
 ```
 
+For more information please visit the [docs](http://www.gabrielcsapo.com/node-git-server/code/index.html)
+
 # Philosophy   
 
 This library is aimed to have a zero dependency footprint. If you are reading this and you see dependencies, help to remove them 🐒.
diff --git a/docs/code/Git.html b/docs/code/Git.html
@@ -553,7 +553,7 @@ <h4 class="name" id="Git"><span class="type-signature"></span>new Git<span class
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Sat Sep 16 2017 19:42:32 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Oct 12 2017 22:09:50 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/code/Service.html b/docs/code/Service.html
@@ -171,7 +171,7 @@ <h3 class="subsection-title">Extends</h3>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Sat Sep 16 2017 19:42:32 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Oct 12 2017 22:09:50 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/code/git.js.html b/docs/code/git.js.html
@@ -279,12 +279,12 @@ <h1 class="page-title">git.js</h1>
         function(req, res) {
             if (req.method !== 'GET') return false;
 
+            var self = this;
             var u = url.parse(req.url);
             var m = u.pathname.match(/\/(.+)\/info\/refs$/);
             if (!m) return false;
             if (/\.\./.test(m[1])) return false;
 
-            var self = this;
             var repo = m[1];
             var params = qs.parse(u.query);
             if (!params.service) {
@@ -463,7 +463,7 @@ <h1 class="page-title">git.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Sat Sep 16 2017 19:42:32 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Oct 12 2017 22:09:50 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/code/global.html b/docs/code/global.html
@@ -945,7 +945,7 @@ <h5>Parameters:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Sat Sep 16 2017 19:42:32 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Oct 12 2017 22:09:50 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/code/index.html b/docs/code/index.html
@@ -56,9 +56,14 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Git.html"
 <a href="https://david-dm.org/gabrielcsapo/node-git-server#info=devDependencies"><img src="https://david-dm.org/gabrielcsapo/node-git-server/dev-status.svg" alt="devDependency Status"></a>
 <a href=""><img src="https://img.shields.io/npm/dt/node-git-server.svg" alt="npm"></a>
 <a href=""><img src="https://img.shields.io/npm/dm/node-git-server.svg" alt="npm"></a></p>
-<p>This library makes it super easy to set up custom git push deploy logic.</p>
-<h1>requirements</h1><pre class="prettyprint source"><code>- git (^ 2.7)</code></pre><h1>install</h1><pre class="prettyprint source"><code>npm install node-git-server</code></pre><h1>example</h1><pre class="prettyprint source lang-javascript"><code>const Server = require('node-git-server');
-const repos = Server('/tmp/repos');
+<h1>Install</h1><pre class="prettyprint source"><code>npm install node-git-server</code></pre><h1>Usage</h1><pre class="prettyprint source lang-javascript"><code>const Server = require('node-git-server');
+const repo = new Server(path.resolve(__dirname, 'tmp'), {
+    autoCreate: true,
+    authenticate: (type, repo, username, password, next) => {
+      console.log(type, repo, username, password);
+      next();
+    }
+});
 const port = process.env.PORT || 7005;
 
 repos.on('push', (push) => {
@@ -84,7 +89,8 @@ <h1>requirements</h1><pre class="prettyprint source"><code>- git (^ 2.7)</code><
 Writing objects: 100% (356/356), 46.20 KiB, done.
 Total 356 (delta 210), reused 355 (delta 210)
 To http://localhost:7005/beep
- * [new branch]      master -> master</code></pre><h1>Philosophy</h1><p>This library is aimed to have a zero dependency footprint. If you are reading this and you see dependencies, help to remove them 🐒.</p>
+ * [new branch]      master -> master</code></pre><p>For more information please visit the <a href="http://www.gabrielcsapo.com/node-git-server/code/index.html">docs</a></p>
+<h1>Philosophy</h1><p>This library is aimed to have a zero dependency footprint. If you are reading this and you see dependencies, help to remove them 🐒.</p>
 <h1>Thanks</h1><p>This is a hard fork from <a href="https://github.com/substack/pushover">pushover</a>.</p></article>
     </section>
 
@@ -98,7 +104,7 @@ <h1>Thanks</h1><p>This is a hard fork from <a href="https://github.com/substack/
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Sat Sep 16 2017 19:42:32 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Oct 12 2017 22:09:50 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/code/module-lib_util.html b/docs/code/module-lib_util.html
@@ -907,7 +907,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Sat Sep 16 2017 19:42:32 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Oct 12 2017 22:09:50 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/code/service.js.html b/docs/code/service.js.html
@@ -86,6 +86,14 @@ <h1 class="page-title">service.js</h1>
         req.pipe(ts).pipe(buffered);
     }
 
+    if(req.headers["authorization"]) {
+      const tokens = req.headers["authorization"].split(" ");
+      if (tokens[0] === "Basic") {
+          const splitHash = new Buffer(tokens[1], 'base64').toString('utf8').split(":");
+          this.username = splitHash.shift();
+      }
+    }
+
     ts.once('data', function(buf) {
         data += buf;
 
@@ -202,7 +210,7 @@ <h1 class="page-title">service.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Sat Sep 16 2017 19:42:32 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Oct 12 2017 22:09:50 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/code/util.js.html b/docs/code/util.js.html
@@ -213,7 +213,7 @@ <h1 class="page-title">util.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Sat Sep 16 2017 19:42:32 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Oct 12 2017 22:09:50 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/psychic-min.css b/docs/psychic-min.css
diff --git a/package.json b/package.json
diff --git a/tryitout.js b/tryitout.js
