diff --git a/README.md b/README.md index aa50faa..f7306ef 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# termap - Terminal Map Viewer +# MapSCII - Map Viewer for your console -No web browser around? No worries - discover the planet in your console! +No web browser around? Don't worry - and discover the planet in your console! @@ -8,24 +8,23 @@ No web browser around? No worries - discover the planet in your console! * Discover the globe or zoom in to explore your neighbourhood * See Point-of-Interest around any given location * Use an online map server or work offline with VectorTile/MBTiles -* Highly customizable styling (colors, feature visibility, ...) -* Compatible with Linux and OS X (Windows to be tested) +* Highly customizable styling (reuse your [mapbox-gl-style](https://github.com/mapbox/mapbox-gl-styles)s) +* Compatible with Linux' and OS X' terminals, Windows support via [PuTTY](http://www.putty.org/) * 99% pure Coffee-/JavaScript! :sunglasses: - - ## How to get it? * Make sure to have at least [node.js](https://nodejs.org/) version 4 installed -* Install `termap` with +* Open your terminal! +* Install `mapscii` with - `npm install -g termap` + `npm install -g mapscii` ## How to use it? #### Basic usage -* Start `termap` with +* Start `mapscii` with - ` termap` + ` mapscii` ## Behind the scenes @@ -63,7 +62,7 @@ No web browser around? No worries - discover the planet in your console! * [ ] VectorTile * [ ] MBTile * [ ] Tileserver - * [ ] termap-server + * [ ] mapscii-server * [ ] telnet * [ ] ssh * [ ] Viewport diff --git a/bin/mapscii.sh b/bin/mapscii.sh new file mode 100755 index 0000000..d571239 --- /dev/null +++ b/bin/mapscii.sh @@ -0,0 +1,6 @@ +#!/bin/sh +':' //; # Based on https://github.com/MrRio/vtop/blob/master/bin/vtop.js +':' //; export TERM=xterm-256color +':' //; exec "$(command -v nodejs || command -v node)" "$0" "$@" +'use strict' +require('../main.js'); diff --git a/package.json b/package.json index 7f8b1a4..0a289c0 100644 --- a/package.json +++ b/package.json @@ -11,6 +11,9 @@ "type": "git", "url": "https://github.com/rastapasta/mapscii.git" }, + "bin": { + "mapscii": "./bin/mapscii.sh" + }, "keywords": [ "map", "console",