Merge pull request #3 from sanctuary-js/davidchambers/everything

everything

.circleci/config.yml

@@ -0,0 +1,36 @@
+version: 2
+
+jobs:
+  build:
+    docker:
+      - image: circleci/node:6
+        environment:
+          NPM_CONFIG_COLOR: false
+          NPM_CONFIG_LOGLEVEL: warn
+          NPM_CONFIG_PROGRESS: false
+          NVM_DIR: /home/circleci/.nvm
+    parallelism: 3
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - nvm-cache-{{ checksum ".circleci/config.yml" }}
+      - run: curl https://raw.githubusercontent.com/creationix/nvm/v0.33.6/install.sh | bash
+      - save_cache:
+          key: nvm-cache-{{ checksum ".circleci/config.yml" }}
+          paths:
+            - /home/circleci/.nvm
+      - run:
+          name: npm install && npm test
+          command: |
+            test_with_version() {
+              source "$NVM_DIR/nvm.sh"
+              nvm install $1
+              nvm exec $1 npm install
+              nvm exec $1 npm test
+            }
+            case $CIRCLE_NODE_INDEX in
+              0) npm install && npm test ;;
+              1) test_with_version 8 ;;
+              2) test_with_version 10 ;;
+            esac

.config

@@ -0,0 +1,2 @@
+repo-owner = sanctuary-js
+repo-name = sanctuary-either

.eslintrc.json

@@ -0,0 +1,16 @@
+{
+  "root": true,
+  "extends": ["./node_modules/sanctuary-style/eslint-es3.json"],
+  "overrides": [
+    {
+      "files": ["*.md"],
+      "globals": {"$": false, "Either": false, "Left": false, "Right": false, "S": false, "Z": false, "show": false, "type": false}
+    },
+    {
+      "files": ["index.js"],
+      "rules": {
+        "no-unused-vars": ["error", {"vars": "all", "varsIgnorePattern": "^S$", "args": "none"}]
+      }
+    }
+  ]
+}

.gitignore

@@ -0,0 +1,2 @@
+/coverage/
+/node_modules/

.npmrc

@@ -0,0 +1 @@
+package-lock=false

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+Note: __README.md__ is generated from comments in __index.js__. Do not modify
+__README.md__ directly.
+
+1.  Update local master branch:
+
+        $ git checkout master
+        $ git pull upstream master
+
+2.  Create feature branch:
+
+        $ git checkout -b feature-x
+
+3.  Make one or more atomic commits, and ensure that each commit has a
+    descriptive commit message. Commit messages should be line wrapped
+    at 72 characters.
+
+4.  Run `npm test`, and address any errors. Preferably, fix commits in place
+    using `git rebase` or `git commit --amend` to make the changes easier to
+    review.
+
+5.  Push:
+
+        $ git push origin feature-x
+
+6.  Open a pull request.

LICENSE

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sanctuary
+Copyright (c) 2016 Plaid Technologies, Inc.
+
+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.