diff --git a/README.md b/README.md index a6e5bc6..7643ac0 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,15 @@ [![Build Status](https://travis-ci.org/tasuk/side-by-side.png?branch=master)](https://travis-ci.org/tasuk/side-by-side) -Visual comparison of different translations of itemized texts; e.g. poems, -bibles, etc. +Easy visual comparison of different translations or versions of itemized texts; +e.g. poems, bibles, etc. ## Usage -*TODO: Include info on nodeless usage.* +Want to set up your own side by side comparison with minimal hassle? + +Go to [latest release](https://github.com/tasuk/side-by-side/releases/latest/), +download the `side-by-side.zip` file and follow the instructions within! ## Development @@ -31,11 +34,38 @@ Point your browser at http://0.0.0.0:8000/base:tests.the_raven/ ### Tests -If you have the grunt dev server running, point your browser at http://0.0.0.0:8000/tests.html. -Otherwise, run tests with `npm test`. +If you have the grunt dev server running, point your browser at +http://0.0.0.0:8000/tests.html. Otherwise, run tests with `npm test`. ### Release -First, upgrade the version number in `package.json`. Commit the change, and create a zip file with the release: +First, upgrade the version number in `package.json`. Commit the change, create +a zip file with the release: node_modules/.bin/grunt release + +Create a release on GitHub, upload the `side-by-side.zip` file. + +## Source & License + +https://github.com/tasuk/side-by-side + +Copyright (c) 2015 Vít Brunner + +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.