👓 working on readme

README.md

@@ -1,40 +1,67 @@
 # termap - Terminal Map Viewer
 
-Discover the world in your console! termap allows you to render and navigate
-VectorTile based maps in your console.
+Discover the world in your console!
 
-* No native dependencies, 100% Coffee-/JavaScript
-* Use your mouse or keyboard to navigate the map
-* Use tile servers or local MBTiles and VectorTiles
+* Use your mouse or keyboard to navigate
+* Watch the globe or zoom down to house numbers
+* Use tile servers, local MBTiles or a single VectorTile
 
 ## How to get it?
 
-`npm install -g termap`
+* Make sure to have [node.js](https://nodejs.org/) installed
+
+* Install `termap` with
+
+  `npm install -g termap`
+
+## How to use it?
+
+* Start `termap` with
+
+  ` termap`
 
 ## Behind the scenes
 
 ### Libraries
-* [`pbf`](https://github.com/mapbox/pbf) for Protobuf decoding
-* [`vector-tile`](https://github.com/mapbox/vector-tile-js) for [VectorTile](https://github.com/mapbox/vector-tile-spec/tree/master/2.1) parsing
+
+* [`drawille-canvas-blessed-contrib`](https://github.com/yaronn/drawille-canvas-blessed-contrib/) for braille rendering
 * [`term-mouse`](https://github.com/CoderPuppy/term-mouse) for mouse handling
 * [`keypress`](https://github.com/TooTallNate/keypress) for input handling
-* [`node-drawille`](https://github.com/madbence/node-drawille/) for braille rendering (to be replaced)
-
+* [`node-mbtiles`](https://github.com/mapbox/node-mbtiles) for MBTiles parsing
+* [`pbf`](https://github.com/mapbox/pbf) for Protobuf decoding
+* [`vector-tile-js`](https://github.com/mapbox/vector-tile-js) for [VectorTile](https://github.com/mapbox/vector-tile-spec/tree/master/2.1) parsing
+* [`sphericalmercator`](https://github.com/mapbox/node-sphericalmercator) for EPSG:3857 <> WGS84 conversions
 
 ## Wishlist
-* node-gyp binding to [libdrawille](https://github.com/Huulivoide/libdrawille) for speed refactor possibilities + filled polygons
+
+* node port of [libdrawille](https://github.com/Huulivoide/libdrawille) - well optimized library, supporting filled polygons
 
 ### TODOs
+* [ ] cli linking
 * [ ] mapping of view to tiles to show
+* [ ] label drawing
+  * [x] support for point labels
+  * [ ] dynamic decluttering of labels
+* [ ] lat/lng-center + zoom based viewport
+* [ ] TileSource class (abstracting URL, mbtiles, single vector tile source)
 * [ ] tile request system
   * [ ] from local mbtiles
   * [ ] from remote url
-* [ ] label drawing
-* [ ] lat/lng-center + zoom based viewport
-* [ ] TileSource class (abstracting URL, mbtiles, single vector tile source)
+    * [ ] permanent caching of received files
 * [ ] zoom while keeping center
 * [ ] API
   * [ ] setCenter
   * [ ] setZoom
 * [x] accurate mouse drag&drop
 * [x] handle console resize
+* [ ] turn this into a [`blessed-contrib`](https://github.com/yaronn/blessed-contrib) widget
+
+## License
+####The MIT License (MIT)
+Copyright (c) 2016 Michael Straßburger
+
+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.