Add Travis-CI for test running (#37)
authorBigBlueHat <byoung@bigbluehat.com>
Tue, 2 Oct 2018 20:14:08 +0000 (16:14 -0400)
committerGitHub <noreply@github.com>
Tue, 2 Oct 2018 20:14:08 +0000 (16:14 -0400)
* Add initial .travis.yml

* Install latest stable of yarn

Travis is a bit behind atm (1.3.2 O.o)

* Lower the yarn version to match README

* Add engines information to all the packages

* Attempt to use multiple .nvmrc files

This is how .nvmrc files work...but not sure about Travis
https://docs.travis-ci.com/user/languages/javascript-with-nodejs/#Specifying-Node.js-versions-using-.nvmrc

* Expand readme to cover usage & dev

* Revert "Attempt to use multiple .nvmrc files"

This reverts commit d4b0b4eff4ae16a96898f4d3f09245eaa06c3a81.

* Add Node 10 to travis

* Removing node 6 because yarn

.travis.yml [new file with mode: 0644]
README.md
package.json
packages/dom/package.json
packages/fragment-identifier/package.json
packages/range/package.json
packages/selector/package.json
packages/text/package.json

diff --git a/.travis.yml b/.travis.yml
new file mode 100644 (file)
index 0000000..4dc7f27
--- /dev/null
@@ -0,0 +1,10 @@
+language: node_js
+node_js:
+  - "8"
+  - "10"
+
+# Travis is pretty behind the curve on their Yarn support...
+# https://docs.travis-ci.com/user/languages/javascript-with-nodejs/#Using-a-specific-yarn-version
+before_install:
+  - curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version 1.5.1
+  - export PATH="$HOME/.yarn/bin:$PATH"
index a81dd32..988f5be 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,12 +7,32 @@
 * [Issue Tracker](https://issues.apache.org/jira/browse/ANNO)
 * [Wiki](https://cwiki.apache.org/confluence/display/ANNO)
 
+## Usage
+
+We're currently pre-releasing development copies of each library that makes up
+the sum total of Apache Annotator's code. You can grab any of them from our
+[npm organization](https://www.npmjs.com/org/annotator).
+
+```sh
+$ # for example...
+$ npm install --save @annotator/dom
+```
+
+##### Requirements
+
+- [node](https://nodejs.org) >= 8.x
+- [yarn](https://www.yarnpkg.com/) >= 1.5.1
+
+
 ## Development
 
 ##### Requirements
 
-- [node](https://nodejs.org) >= 6.x
-- [yarn](https://www.yarnpkg.com/) >= 1.5.x
+We use [Lerna](https://lernajs.io/) to juggle the various Apache Annotator
+libraries. If you'd like to contribute, you'll need the following:
+
+- [node](https://nodejs.org) >= 8.x
+- [yarn](https://www.yarnpkg.com/) >= 1.5.1
 
 ##### Setup
 
index 22006b9..8ba1380 100644 (file)
@@ -59,7 +59,7 @@
     "webpack-serve": "^0.2.0"
   },
   "engines": {
-    "node": ">=6.0.0",
+    "node": ">=8.0.0",
     "yarn": "^1.5.0"
   },
   "workspaces": {
index 29243e5..0dfdd08 100644 (file)
@@ -18,5 +18,8 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "engines": {
+    "node": ">=6.0.0"
   }
 }
index ca4c93f..5a27ebe 100644 (file)
@@ -21,5 +21,8 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "engines": {
+    "node": ">=6.0.0"
   }
 }
index cfee65a..f58e5b7 100644 (file)
@@ -18,5 +18,8 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "engines": {
+    "node": ">=6.0.0"
   }
 }
index a25eb6c..bbbdb00 100644 (file)
@@ -15,5 +15,8 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "engines": {
+    "node": ">=6.0.0"
   }
 }
index 54e3df6..ad952dd 100644 (file)
@@ -15,5 +15,8 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "engines": {
+    "node": ">=6.0.0"
   }
 }