remove unused files and update readme

Author: wojtek-krysiak

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 SoftwareBrothers.co
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,12 +1,83 @@
-The default template for JSDoc 3 uses: [the Taffy Database library](http://taffydb.com/) and the [Underscore Template library](http://underscorejs.org/).
+# BetterDocs
 
+Beautiful and simple documentation template for JSDoc 3.
 
-## Generating Typeface Fonts
+## Installation
 
-The default template uses the [OpenSans](https://www.google.com/fonts/specimen/Open+Sans) typeface. The font files can be regenerated as follows:
+```sh
+npm install --save-dev better-docs
+```
 
-1. Open the [OpenSans page at Font Squirrel](<http://www.fontsquirrel.com/fonts/open-sans>).
-2. Click on the 'Webfont Kit' tab.
-3. Either leave the subset drop-down as 'Western Latin (Default)', or, if we decide we need more glyphs, than change it to 'No Subsetting'.
-4. Click the 'DOWNLOAD @FONT-FACE KIT' button.
-5. For each typeface variant we plan to use, copy the 'eot', 'svg' and 'woff' files into the 'templates/default/static/fonts' directory.
+## Usage
+
+### With command line
+
+Assuming that you have jsdoc installed globally:
+
+```
+jsdoc your-documented-file.js -t ./node_modules/better-docs
+```
+
+### With npm and configuration file
+
+In your projects package.json file add a new script:
+
+```
+"script": {
+  "docs": "node_modules/.bin/jsdoc -c jsdoc.json"
+}
+```
+
+in your `jsdoc.json` file, set the template:
+
+"opts": {
+  "template": "node_modules/better-docs"
+}
+
+## Setting up for the development
+
+If you want to change the theam locally follow the steps:
+
+1. Clone the repo to the folder where you have the project:
+
+```
+cd your-project
+git clone [email protected]:SoftwareBrothers/better-docs.git
+```
+
+or add it as a git submodule:
+
+```
+git submodule add [email protected]:SoftwareBrothers/better-docs.git
+```
+
+2. Install the packages
+
+```
+npm install
+
+# or
+
+yarn
+```
+
+3. Within the better-docs folder run the gulp script. It will regenerate documentation everytime you change something.
+
+```
+cd better-docs
+DOCS_COMMAND='npm run docs' DOCS_OUTPUT='../docs' cd better-docs && gulp
+```
+
+## License
+
+BetterDocs is Copyright © 2019 SoftwareBrothers.co. It is free software and may be redistributed under the terms specified in the [LICENSE](LICENSE) file.
+
+## About SoftwareBrothers.co
+
+<img src="https://softwarebrothers.co/assets/images/software-brothers-logo-full.svg" width=240>
+
+
+We’re an open, friendly team that helps clients from all over the world to transform their businesses and create astonishing products.
+
+* We are available to [hire](https://softwarebrothers.co/contact).
+* If you want to work for us - check out the [career page](https://softwarebrothers.co/career).

gulpfile.js

@@ -1,12 +1,14 @@
-const { spawn } = require('child_process')
+const DOCS_COMMAND = process.env.DOCS_COMMAND || 'npm run docs'
+const DOCS_OUTPUT = process.env.DOCS_OUTPUT || "../docs"
+
+
 const gulp = require('gulp')
 const sass = require('gulp-sass')
 const autoprefixer = require('gulp-autoprefixer')
 const run = require('gulp-run')
 const babel = require('gulp-babel')
 const uglify = require('gulp-uglify')
 const rename = require('gulp-rename')
-const nodemon = require('gulp-nodemon')
 const concat = require('gulp-concat')
 const path = require('path')
 const browserSync = require('browser-sync').create();
@@ -33,7 +35,7 @@ gulp.task('js', () => {
 })
 
 gulp.task('docs', function() {
-  return run('cd .. && npm run docs').exec()
+  return run(`cd .. && ${DOCS_COMMAND}`).exec()
 })
 
 gulp.task('watch', () => {
@@ -45,10 +47,10 @@ gulp.task('watch', () => {
 gulp.task('sync', () => {
   browserSync.init({
     server: {
-      baseDir: "../docs"
+      baseDir: DOCS_OUTPUT
     }
   })
-  gulp.watch("../docs/*").on('change', browserSync.reload)
+  gulp.watch(`${DOCS_OUTPUT}/*`).on('change', browserSync.reload)
 })
 
 gulp.task('default', ['sass', 'js', 'docs', 'watch', 'sync'])

output/cd

@@ -4,7 +4,7 @@
   "description": "JSdoc theme",
   "main": "publish.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "gulp": "./node_modules/.bin/gulp"
   },
   "author": "Wojciech Krysiak",
   "license": "MIT",