📖 updating readme header

This commit is contained in:
Michael Straßburger 2016-09-20 23:02:21 +02:00
parent 2877fc0010
commit f5ff8a4a6b

View File

@ -1,25 +1,29 @@
# termap - Terminal Map Viewer # termap - Terminal Map Viewer
Discover the world in your console! No web browser around? No worries - discover the planet in your console!
* Use your mouse or keyboard to navigate * Use your mouse or keys to navigate
* Watch the globe or zoom down to house numbers * Discover the globe or zoom in to learn about house numbers
* Use tile servers, local MBTiles or a single VectorTile * 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)
* 99% pure Coffee-/JavaScript! :sunglasses:
## How to get it? ## How to get it?
* Make sure to have [node.js](https://nodejs.org/) installed * Make sure to have at least [node.js](https://nodejs.org/) version 4 installed
* Install `termap` with * Install `termap` with
`npm install -g termap` `npm install -g termap`
## How to use it? ## How to use it?
#### Basic usage
* Start `termap` with * Start `termap` with
` termap` ` termap`
## Behind the scenes ## Behind the scenes
### Libraries ### Libraries
#### Mastering the console #### Mastering the console