Merge branch 'master' into greenkeeper/update-all

Author: Aurélien Ooms

.codacy.yml

@@ -0,0 +1,6 @@
+languages:
+  JavaScript: true
+exclude_paths:
+- "doc/**"
+- "lib/**"
+- "test/**"

.codeclimate.yml

@@ -1,7 +1,6 @@
 languages:
   JavaScript: true
 exclude_paths:
-- "js/dist/*.js"
-- "js/dist/**/*.js"
-- "test/*.js"
-- "test/**/*.js"
+- "doc/**"
+- "lib/**"
+- "test/**"

.gitignore

@@ -1,30 +1,10 @@
-# Logs
-logs
-*.log
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
 # Dependency directory
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
+jspm_packages
+
+# Coverage directory used by nyc
+coverage
+.nyc_output
 
-# groc
-doc
+# Documentation
+gh-pages

.groc.json

@@ -1,17 +1,15 @@
 language: node_js
 
 node_js:
-  - "iojs"
-  - "0.12"
-  - "0.11"
-  - "0.10"
+  - node
 
 install:
-  - npm -d install
+  - npm install
 
 script:
-  - npm test
+  - npm run cover
 
 after_success:
-  - ./node_modules/.bin/coveralls   < coverage/lcov.info || true
-  - ./node_modules/.bin/codeclimate < coverage/lcov.info || true
+  - bash <(curl -s https://codecov.io/bash)        || true
+  - coveralls                 < coverage/lcov.info || true
+  - codeclimate-test-reporter < coverage/lcov.info || true

.travis.yml

@@ -1,95 +1,18 @@
-[js-2sat](http://aureooms.github.io/js-2sat)
+[@aureooms/js-2sat](https://aureooms.github.io/js-2sat)
 ==
 
-2-Satisfiability code bricks for JavaScript
+2-Satisfiability library for JavaScript.
+See [docs](https://aureooms.github.io/js-2sat).
+Parent is [@aureooms/js-algorithms](https://github.com/aureooms/js-algorithms).
+
+[![License](https://img.shields.io/github/license/aureooms/js-2sat.svg?style=flat)](https://raw.githubusercontent.com/aureooms/js-2sat/master/LICENSE)
+[![NPM version](https://img.shields.io/npm/v/@aureooms/js-2sat.svg?style=flat)](https://www.npmjs.org/package/@aureooms/js-2sat)
+[![Build Status](https://img.shields.io/travis/aureooms/js-2sat.svg?style=flat)](https://travis-ci.org/aureooms/js-2sat)
+[![Coverage Status](https://img.shields.io/coveralls/aureooms/js-2sat.svg?style=flat)](https://coveralls.io/r/aureooms/js-2sat)
+[![Dependencies Status](https://img.shields.io/david/aureooms/js-2sat.svg?style=flat)](https://david-dm.org/aureooms/js-2sat#info=dependencies)
+[![devDependencies Status](https://img.shields.io/david/dev/aureooms/js-2sat.svg?style=flat)](https://david-dm.org/aureooms/js-2sat#info=devDependencies)
+[![Code Climate](https://img.shields.io/codeclimate/github/aureooms/js-2sat.svg?style=flat)](https://codeclimate.com/github/aureooms/js-2sat)
+[![NPM downloads per month](https://img.shields.io/npm/dm/@aureooms/js-2sat.svg?style=flat)](https://www.npmjs.org/package/@aureooms/js-2sat)
+[![GitHub issues](https://img.shields.io/github/issues/aureooms/js-2sat.svg?style=flat)](https://github.com/aureooms/js-2sat/issues)
+[![Documentation](https://aureooms.github.io/js-2sat/badge.svg)](https://aureooms.github.io/js-2sat/source.html)
 
-[![NPM license](http://img.shields.io/npm/l/aureooms-js-2sat.svg?style=flat)](https://raw.githubusercontent.com/aureooms/js-2sat/master/LICENSE)
-[![NPM version](http://img.shields.io/npm/v/aureooms-js-2sat.svg?style=flat)](https://www.npmjs.org/package/aureooms-js-2sat)
-[![Bower version](http://img.shields.io/bower/v/aureooms-js-2sat.svg?style=flat)](http://bower.io/search/?q=aureooms-js-2sat)
-[![Build Status](http://img.shields.io/travis/aureooms/js-2sat.svg?style=flat)](https://travis-ci.org/aureooms/js-2sat)
-[![Coverage Status](http://img.shields.io/coveralls/aureooms/js-2sat.svg?style=flat)](https://coveralls.io/r/aureooms/js-2sat)
-[![Dependencies Status](http://img.shields.io/david/aureooms/js-2sat.svg?style=flat)](https://david-dm.org/aureooms/js-2sat#info=dependencies)
-[![devDependencies Status](http://img.shields.io/david/dev/aureooms/js-2sat.svg?style=flat)](https://david-dm.org/aureooms/js-2sat#info=devDependencies)
-[![Code Climate](http://img.shields.io/codeclimate/github/aureooms/js-2sat.svg?style=flat)](https://codeclimate.com/github/aureooms/js-2sat)
-[![NPM downloads per month](http://img.shields.io/npm/dm/aureooms-js-2sat.svg?style=flat)](https://www.npmjs.org/package/aureooms-js-2sat)
-[![GitHub issues](http://img.shields.io/github/issues/aureooms/js-2sat.svg?style=flat)](https://github.com/aureooms/js-2sat/issues)
-[![Inline docs](http://inch-ci.org/github/aureooms/js-2sat.svg?branch=master&style=shields)](http://inch-ci.org/github/aureooms/js-2sat)
-
-Can be managed through [jspm](https://github.com/jspm/jspm-cli),
-[duo](https://github.com/duojs/duo),
-[component](https://github.com/componentjs/component),
-[bower](https://github.com/bower/bower),
-[ender](https://github.com/ender-js/Ender),
-[jam](https://github.com/caolan/jam),
-[spm](https://github.com/spmjs/spm),
-and [npm](https://github.com/npm/npm).
-
-## Install
-
-### jspm
-```terminal
-jspm install github:aureooms/js-2sat
-# or
-jspm install npm:aureooms-js-2sat
-```
-### duo
-No install step needed for duo!
-
-### component
-```terminal
-component install aureooms/js-2sat
-```
-
-### bower
-```terminal
-bower install aureooms-js-2sat
-```
-
-### ender
-```terminal
-ender add aureooms-js-2sat
-```
-
-### jam
-```terminal
-jam install aureooms-js-2sat
-```
-
-### spm
-```terminal
-spm install aureooms-js-2sat --save
-```
-
-### npm
-```terminal
-npm install aureooms-js-2sat --save
-```
-
-## Require
-### jspm
-```js
-let 2sat = require( "github:aureooms/js-2sat" ) ;
-// or
-import 2sat from 'aureooms-js-2sat' ;
-```
-### duo
-```js
-let 2sat = require( "aureooms/js-2sat" ) ;
-```
-
-### component, ender, spm, npm
-```js
-let 2sat = require( "aureooms-js-2sat" ) ;
-```
-
-### bower
-The script tag exposes the global variable `2sat`.
-```html
-<script src="bower_components/aureooms-js-2sat/js/dist/2sat.min.js"></script>
-```
-Alternatively, you can use any tool mentioned [here](http://bower.io/docs/tools/).
-
-### jam
-```js
-require( [ "aureooms-js-2sat" ] , function ( 2sat ) { ... } ) ;
-```

README.md

@@ -0,0 +1,52 @@
+h1,
+h2,
+.navigation,
+.layout-container > header,
+footer
+{
+	border: none;
+}
+
+.project-name {
+  color: #FC913A;
+  font-weight: bold;
+}
+
+.layout-container > header > a.repo-url-github {
+    font-size: inherit;
+    display: inline;
+    background: none;
+    vertical-align: inherit;
+}
+
+.search-box img {
+	display: none;
+}
+
+.search-box::before{
+	content: "search";
+}
+
+.search-input-edge {
+	height: 0px;
+}
+
+.search-result {
+    width: 300px;
+    margin-left: 42px;
+	box-shadow: 1px 1px 13px rgba(0,0,0,0.2);
+}
+
+.search-input {
+	visibility: visible;
+}
+
+.search-result li.search-separator {
+	text-transform: capitalize;
+	background-color: #ccc;
+}
+
+span[data-ice="signature"] > span {
+	/*font-weight: bold;*/
+	font-style: italic;
+}

bower.json

@@ -0,0 +1,13 @@
+Can be managed using
+[jspm](http://jspm.io)
+or [npm](https://github.com/npm/npm).
+
+### jspm
+```terminal
+jspm install npm:@aureooms/js-2sat
+```
+
+### npm
+```terminal
+npm install @aureooms/js-2sat --save
+```

component.json

@@ -0,0 +1,14 @@
+The code needs a ES2015+ polyfill to work, for example
+[babel-polyfill](https://babeljs.io/docs/usage/polyfill).
+```js
+require( 'babel-polyfill' ) ;
+// or
+import 'babel-polyfill' ;
+```
+
+Then
+```js
+const 2sat = require( '@aureooms/js-2sat' ) ;
+// or
+import 2sat from '@aureooms/js-2sat' ;
+```

doc/css/style.css

@@ -0,0 +1,34 @@
+var domReady = function(callback) {
+	var state = document.readyState ;
+    if ( state === 'interactive' || state === 'complete' ) {
+		callback() ;
+	}
+	else {
+		document.addEventListener('DOMContentLoaded', callback);
+	}
+} ;
+
+
+domReady(function(){
+
+	var projectname = document.createElement('a');
+	projectname.classList.add('project-name');
+	projectname.text = 'aureooms/js-2sat';
+	projectname.href = './index.html' ;
+
+	var header = document.getElementsByTagName('header')[0] ;
+	header.insertBefore(projectname,header.firstChild);
+
+	var testlink = document.querySelector('header > a[data-ice="testLink"]') ;
+	testlink.href = 'https://coveralls.io/github/aureooms/js-2sat' ;
+	testlink.target = '_BLANK' ;
+
+	var searchBox = document.querySelector('.search-box');
+	var input = document.querySelector('.search-input');
+
+	// active search box when focus on searchBox.
+	input.addEventListener('focus', function(){
+		searchBox.classList.add('active');
+	});
+
+});

doc/manual/example.md

@@ -0,0 +1,37 @@
+{
+  "source": "./src",
+  "destination": "./gh-pages",
+  "access": [
+    "public",
+    "protected",
+    "private"
+  ],
+  "debug": false,
+  "index": "./README.md",
+  "package": "./package.json",
+  "title": "aureooms/js-2sat",
+  "test": {
+    "type": "ava",
+    "source": "./test/src"
+  },
+  "manual": {
+    "overview": [
+      "./doc/manual/overview.md"
+    ],
+    "installation": [
+      "./doc/manual/installation.md"
+    ],
+    "usage": [
+      "./doc/manual/usage.md"
+    ],
+    "example": [
+      "./doc/manual/example.md"
+    ]
+  },
+  "styles": [
+    "./doc/css/style.css"
+  ],
+  "scripts": [
+    "./doc/scripts/header.js"
+  ]
+}