Merge 02bd8c9 into 29fbbd1

.docma.js

@@ -0,0 +1,142 @@
+const Docma = require('docma');
+
+const config = {
+  debug: 5,
+  jsdoc: {
+    encoding: 'utf8',
+    recurse: false,
+    pedantic: false,
+    access: null,
+    package: null,
+    module: true,
+    undocumented: false,
+    undescribed: false,
+    ignored: false,
+    hierarchy: true,
+    sort: 'alphabetic',
+    relativePath: null,
+    filter: null,
+    allowUnknownTags: true,
+    plugins: [],
+  },
+  markdown: {
+    gfm: true,
+    tables: true,
+    breaks: false,
+    pedantic: false,
+    sanitize: false,
+    smartLists: true,
+    smartypants: false,
+    xhtml: false,
+    tasks: true,
+    emoji: true,
+  },
+  app: {
+    title: 'Make-Believe',
+    meta: null,
+    base: '/',
+    entrance: 'content:readme', // use "api:your-lib" to set the entrance to a JSAPI page
+    routing: 'path',
+    server: 'github',
+    favicon: 'docs/img/favicon/favicon-16x16.png', // local path of favicon to be copied
+  },
+  src: [
+    './src/**/*.js',
+    './LICENSE:md',
+    './README.md',
+    './docs/*.md'
+  ],
+  assets: {
+    '/img': ['./docs/img/*.*','./docs/img/bubble-logo.svg'],
+  },
+  dest: './site_output',
+  template: {
+    path: 'zebra',
+    options: {
+      title: {
+        label: 'Make-Believe',
+        href: '.',
+      },
+      logo: { // URL String or { dark: String, light: String }
+        dark: 'img/bubble-logo.svg',
+        light: 'img/bubble-logo.svg',
+      },
+      sidebar: {
+        enabled: true,
+        outline: 'tree', // "flat" | "tree"
+        collapsed: false,
+        toolbar: false,
+        itemsFolded: false,
+        itemsOverflow: 'crop', // "crop" | "shrink"
+        badges: true, // true | false | <string-value>
+        search: true,
+        animations: true,
+      },
+      symbols: {
+        autoLink: true, // "internal" | "external" | true (both)
+        params: 'list', // "list" | "table"
+        enums: 'list', // "list" | "table"
+        props: 'list', // "list" | "table"
+        meta: false,
+      },
+      contentView: {
+        bookmarks: 'h1,h2,h3',
+        faLibs: 'all', // "all" or "solid"|"regular"|"brands" or comma-separated or null
+      },
+      navbar: {
+        enabled: true,
+        fixed: true,
+        dark: false,
+        animations: true,
+        menu: [
+          {
+            label: 'Home',
+            href: '.',
+          },
+          {
+            label: 'Getting Started',
+            href: 'getting_started',
+          },
+          {
+            // "iconClass": "fas fa-book",
+            label: 'Examples',
+            items: [
+              { label: 'Simple Example', href: 'simple_example' },
+              { separator: true },
+              { label: 'Advanced Example', href: 'advanced_example' },
+            ],
+          },
+          {
+            label: 'API',
+            href: 'api',
+          },
+          {
+            // "iconClass": "fas fa-book",
+            label: 'About',
+            items: [
+              { label: 'License', href: 'license' },
+              { separator: true },
+              { label: 'Code of Conduct', href: 'code_of_conduct' },
+              { separator: true },
+              { label: 'Developing', href: 'developing' },
+            ],
+          },
+          {
+            iconClass: 'fab fa-lg fa-github',
+            label: '',
+            href: 'https://github.com/mcherryleigh/make-believe',
+            target: '_blank',
+          },
+        ],
+      },
+    },
+  },
+};
+
+console.log(JSON.stringify(config))
+
+/*Docma.create()
+  .build(config)
+  .catch((error) => {
+    console.log(error);
+  });*/

.travis.yml

@@ -31,7 +31,7 @@ jobs:
         - "10"
       script: npm run docs-build
       deploy:
-        local-dir: docs
+        local-dir: site_output
         provider: pages
         skip-cleanup: true
         github-token: $GH_TOKEN

README.md

@@ -1,7 +1,39 @@
 # Make-Believe
 
 [![npm version](http://img.shields.io/npm/v/make-believe.svg?style=flat)](https://npmjs.org/package/make-believe "View this project on npm")
+[![](https://img.shields.io/github/release-date/mcherryleigh/make-believe.svg)](https://github.com/mcherryleigh/make-believe)
 [![Dependencies](http://img.shields.io/david/mcherryleigh/make-believe.svg?style=flat)](https://david-dm.org/mcherryleigh/make-believe)
+
 [![Status](https://travis-ci.com/mcherryleigh/make-believe.svg?branch=master)](https://travis-ci.com/mcherryleigh/make-believe)
 [![Coveralls](http://img.shields.io/coveralls/mcherryleigh/make-believe.svg?style=flat)](https://coveralls.io/r/mcherryleigh/make-believe)
-[![BCH compliance](https://bettercodehub.com/edge/badge/mcherryleigh/make-believe?branch=master)](https://bettercodehub.com/) [![Greenkeeper badge](https://badges.greenkeeper.io/mcherryleigh/make-believe.svg)](https://greenkeeper.io/)
+[![BCH compliance](https://bettercodehub.com/edge/badge/mcherryleigh/make-believe?branch=master)](https://bettercodehub.com/)
+[![Greenkeeper badge](https://badges.greenkeeper.io/mcherryleigh/make-believe.svg)](https://greenkeeper.io/)
+
+[![Waffle.io - Columns and their card count](https://badge.waffle.io/mcherryleigh/make-believe.svg?columns=all)](https://waffle.io/mcherryleigh/make-believe)
+# Make-believe
+> A dreamy test data framework for NodeJS
+
+Make-Believe is a javascript library for generating and managing test data for software applications. 
+
+## Features
+
+Under Construction
+
+## Links
+- Project homepage: https://mcherryleigh.github.com/make-believe
+- Repository: https://github.com/mcherryleigh/make-believe
+- Issue tracker: https://github.com/mcherryleigh/make-believe/issues
+
+## Licensing
+The code in this project is licensed under MIT license. You can view the license [here](https://github.com/mcherryleigh/make-believe/blob/master/LICENSE).
+
+## Support
+
+__Bugs and requests__: submit them through the project's issues tracker.<br>
+[![Issues](http://img.shields.io/github/issues/mcherryleigh/make-believe.svg)]( https://github.com/mcherryleigh/make-believe/issues )
+
+__Questions__: ask them at StackOverflow with the tag *REPO*.<br>
+[![StackOverflow](http://img.shields.io/badge/stackoverflow-make--believe-blue.svg)]( http://stackoverflow.com/questions/tagged/make-believe )
+
+__Chat__: join us at gitter.im.<br>
+[![Chat](http://img.shields.io/badge/gitter.im-mcherryleigh/make--believe-blue.svg)]( https://gitter.im/mcherryleigh/make-believe )

docs/ADVANCED_EXAMPLE.md

@@ -0,0 +1,3 @@
+# Advanced Make-Believe Example
+
+Under Construction

docs/DEVELOPING.md

@@ -0,0 +1,12 @@
+## Developing
+
+Here's a brief intro about what a developer must do in order to start developing
+the project further:
+
+```shell
+git clone https://github.com/mcherryleigh/make-believe.git
+cd make-believe/
+npm install
+```
+
+And state what happens step-by-step.

docs/GETTING_STARTED.md

@@ -0,0 +1,35 @@
+# Installing / Getting started
+
+A quick introduction of the minimal setup you need to get a hello world up &
+running.
+
+```shell
+npm install --save make-believe
+```
+
+Make-Believe at its simplest can be used as a (predictable) random value generator
+
+
+```javascript
+import { RandomValue } from 'make-believe';
+import { boolean, integer } from 'make-believe-values-basics';
+
+const rv = new RandomValue()
+  .seed('hello world')
+  .addPlugins([
+    [boolean, integer],
+    {
+      name: 'oneOrTwo',
+      func: (rv, options) => {
+        if (options.one) {
+          return 1;
+        }
+        rv.pick([1, 2]);
+      },
+    },
+  ]);
+
+console.log(rv.boolean()); // false
+console.log(rv.integer({ min: 0, max: 100 })); // 67
+consolt.log(rv.oneOrTwo()); //  2
+```

docs/SIMPLE_EXAMPLE.md

@@ -0,0 +1,3 @@
+# Simple Make-Believe Example
+
+Under Construction