diff --git a/README.md b/README.md index 4cdabab5..748bf928 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,8 @@ Tile38 is an open source (MIT licensed), in-memory geolocation data store, spati The easiest way to get Tile38 is to use one of the pre-built release binaries which are available for OSX, Linux, and Windows. Instructions for using these binaries are on the GitHub [releases page](https://github.com/tidwall/tile38/releases). +Tile38 is also available as a [Docker image](https://hub.docker.com/r/tile38/tile38/) which is built on top of [Alpine Linux](https://alpinelinux.org/). + If you want to try the latest version, you can build Tile38 from the master branch. ### Building Tile38 diff --git a/doc/logo200.png b/doc/logo200.png new file mode 100644 index 00000000..56a32767 Binary files /dev/null and b/doc/logo200.png differ diff --git a/Dockerfile b/docker/Dockerfile similarity index 100% rename from Dockerfile rename to docker/Dockerfile diff --git a/docker/README.md b/docker/README.md new file mode 100644 index 00000000..33487c89 --- /dev/null +++ b/docker/README.md @@ -0,0 +1,24 @@ +![Tile38 Logo](https://github.com/tidwall/tile38/blob/master/doc/logo200.png) + +Tile38 is an open source (MIT licensed), in-memory geolocation data store, spatial index, and realtime geofence. It supports a variety of object types including lat/lon points, bounding boxes, XYZ tiles, Geohashes, and GeoJSON. + +*For more information visit: [http://tile38.com](http://tile38.com)* + +## Features + +- Spatial index with [search](#searching) methods such as Nearby, Within, and Intersects. +- Realtime [geofencing](#geofencing) through persistent sockets or [webhooks](http://tile38.com/commands/sethook). +- Object types of [lat/lon](#latlon-point), [bbox](#bounding-box), [Geohash](#geohash), [GeoJSON](#geojson), [QuadKey](#quadkey), and [XYZ tile](#xyz-tile). +- Support for lots of [Clients Libraries](#client-libraries) written in many different langauges. +- Variety of protocols, including [http](#http) (curl), [websockets](#websockets), [telnet](#telnet), and the [Redis RESP](http://redis.io/topics/protocol). +- Server responses are [RESP](http://redis.io/topics/protocol) or [JSON](http://www.json.org). +- Full [command line interface](#cli). +- Leader / follower [replication](#replication). +- In-memory database that persists on disk. + +## Contact +Josh Baker [@tidwall](http://twitter.com/tidwall) + +## License + +Tile38 source code is available under the MIT [License](/LICENSE).