diff --git a/README.md b/README.md index ad9029c..1ae8529 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,66 @@ Have fun! * USPO creation over time: http://cartodb.github.com/torque/examples/uspo.html * OpenStreetMap edits in Madrid over time: http://cartodb.github.com/torque/examples/osm.html * The Guardian's Data Blog write-up of Royal Navy ships in WWI: http://www.guardian.co.uk/news/datablog/interactive/2012/oct/01/first-world-war-royal-navy-ships-mapped + +## Torque library reference + +Torque lets you render big, timeseries or categorical data in the client. This is useful for many modern applications that need more than just a static map. Early versions of Torque have been used to visualize human movement, Twitter activity, biodiversity data, and many more large-scale datasets. + +The library uses CartoDB to generate a [layercube]() format. For a brief introduction to the format and methods, see our [presentation slides](http://gijs.github.com/images/cartodb_datacubes.pdf). If you are not using CartoDB to host your data, you can modify the input parameters to point toward any layercube service. + +### Getting started + +The simplest way to use a visualization with Torque is... + +
+
Create a simple Torque visualization
+ ``` javascript + ... + +
+ + ... + + ``` +
+ +[Grab the complete example source code](https://github.com/CartoDB/cartodb.js/blob/develop/examples/easy.html)