[chore] fixes website publishing and updates website content

Author: gabrielcsapo

.github/workflows/ci.yml

@@ -16,12 +16,12 @@ on:
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   test:
-    name: "Node ${{ matrix.node }} - ${{ matrix.os }}"
+    name: 'Node ${{ matrix.node }} - ${{ matrix.os }}'
     runs-on: ${{ matrix.os }}-latest
 
     strategy:
       matrix:
-        node: ["14", "16", "latest"]
+        node: ['14', '16', 'latest']
         os: [ubuntu, macOS, windows]
 
     steps:
@@ -47,12 +47,10 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: "16.x"
+          node-version: '16.x'
       - uses: webfactory/[email protected]
         with:
           ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}
-      - name: install dependencies
-        run: npm i
       - name: Release to GitHub Pages
         env:
           USE_SSH: true
@@ -61,4 +59,5 @@ jobs:
           git config --global user.email "[email protected]"
           git config --global user.name "Gabriel J. Csapo"
           cd website
+          npm install
           npm run deploy

README.md

@@ -18,199 +18,7 @@ npm install node-git-server
 
 # Usage
 
-## Simple
-
-```typescript
-import { Git } from 'node-git-server';
-import { join } from 'path';
-
-const port = !process.env.PORT || isNaN(process.env.PORT)
-  ? 7005
-  : parseInt(process.env.PORT);
-
-const repos = new Git(
-  join(__dirname, '../repo'),
-  {
-    autoCreate: true,
-  }
-);
-
-repos.on('push', push => {
-  console.log(`push ${push.repo}/${push.commit} ( ${push.branch} )`);
-  push.accept();
-});
-
-repos.on("fetch", fetch => {
-  console.log(`fetch ${fetch.commit}`);
-  fetch.accept();
-});
-
-repos.listen(port, () => {
-  console.log(`node-git-server running at http://localhost:${port}`);
-});
-```
-
-then start up the node-git-server server...
-
-```
-$ node example/index.js
-node-git-server running at http://localhost:7005
-```
-
-meanwhile...
-
-```
-$ git push http://localhost:7005/beep master
-Counting objects: 356, done.
-Delta compression using up to 2 threads.
-Compressing objects: 100% (133/133), done.
-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
-```
-
-## Sending logs
-
-```typescript
-import { Git } from 'node-git-server';
-import { join } from 'path';
-
-const port = !process.env.PORT || isNaN(process.env.PORT)
-  ? 7005
-  : parseInt(process.env.PORT);
-
-const repos = new Git(
-  join(__dirname, '../repo'),
-  {
-    autoCreate: true,
-  }
-);
-
-repos.on('push', async push => {
-  console.log(`push ${push.repo}/${push.commit} ( ${push.branch} )`);
-
-  push.log();
-  push.log('Hey!');
-  push.log('Checkout these other repos:');
-  for (const repo of await repo.list()) {
-    push.log(`- ${repo}`);
-  }
-  push.log();
-  push.accept();
-});
-
-repos.on("fetch", fetch => {
-  console.log(`fetch ${fetch.commit}`);
-  fetch.accept();
-});
-
-repos.listen(port, () => {
-  console.log(`node-git-server running at http://localhost:${port}`);
-});
-```
-
-then start up the node-git-server server...
-
-```
-$ node example/index.js
-node-git-server running at http://localhost:7005
-```
-
-meanwhile...
-
-```
-$ git push http://localhost:7005/beep master
-Counting objects: 356, done.
-Delta compression using up to 2 threads.
-Compressing objects: 100% (133/133), done.
-Writing objects: 100% (356/356), 46.20 KiB, done.
-Total 356 (delta 210), reused 355 (delta 210)
-remote:
-remote: Hey!
-remote: Checkout these other repos:
-remote: - test.git
-remote:
-To http://localhost:7005/test
-   77bb26e..22918d5  master -> master
-```
-
-### Authentication
-
-```typescript
-import { Git } from 'node-git-server';
-import { join } from 'path';
-
-const port = !process.env.PORT || isNaN(process.env.PORT)
-  ? 7005
-  : parseInt(process.env.PORT);
-
-const repos = new Git(
-  join(__dirname, '../repo'),
-  {
-    autoCreate: true,
-    autheficate: ({ type, user }, next) =>
-      type == 'push'
-      ? user(([username, password]) => {
-        console.log(username, password);
-        next();
-      })
-      : next()
-  }
-);
-
-repos.on('push', push => {
-  console.log(`push ${push.repo}/${push.commit} ( ${push.branch} )`);
-  push.accept();
-});
-
-repos.on("fetch", fetch => {
-  console.log(`fetch ${fetch.commit}`);
-  fetch.accept();
-});
-
-repos.listen(port, () => {
-  console.log(`node-git-server running at http://localhost:${port}`);
-});
-```
-
-then start up the node-git-server server...
-
-```
-$ node example/index.js
-node-git-server running at http://localhost:7005
-```
-
-meanwhile...
-
-```
-$ git push http://localhost:7005/beep master
-Counting objects: 356, done.
-Delta compression using up to 2 threads.
-Compressing objects: 100% (133/133), done.
-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
-```
-
-# Example
-
-Running the following command will start up a simple http server:
-
-```
-node example/index.js
-```
-
-If you want to try using https run the following
-
-```
-node example/index.js --https
-```
-
-> When running https with self-signed certs there are two ways to override the git-clients behavior using `git config http.sslVerify false` or `git config --global http.sslCAInfo /path/to/cert.pem`
-
-For more information please visit the [docs](http://www.gabrielcsapo.com/node-git-server/code/index.html)
+Please visit our docs [https://gabrielcsapo.github.io/node-git-server](https://gabrielcsapo.github.io/node-git-server)!
 
 # Philosophy