diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..cdaeaf22de49e003ec707958e7571bc69a28315d --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Installation + +Add Maven repository + + https://mvn.tickaroo.com + +to your project and + + com.tickaroo:sdk:2.8.0 + +to the dependencies of your app. + +# Javadoc + + http://builds.tickaroo.net/pub/doc/embed/android/ + +# Integration + +First you have to initialize `TickarooEmbedManager` by invoking the default constructor. This has to be done exactly once. For your `TickarooEmbedManager` you have to provide an implementation of `TickarooEmbedManagerDelegate`. + +# Styling + +The following four colours can be overridden in the resources: + +- tickaroo\_primary\_color +- tickaroo\_primary\_color\_dark +- tickaroo\_accent\_color +- tickaroo\_accent\_color\_dark + +By default the primary colours are green and the accent colours are orange. + +The following four fonts can be changed to any standard android font family by overwriting the values in res/values-v16/strings.xml + +- font\_family\_medium +- font\_family\_light +- font\_family\_black +- font\_family\_regular + +By default these are set to the corresponding sans-serif font families, normally Roboto. The comic font can be replaced by a custom font file in assets/fonts. The file name is specified by the string font\_file\_comic \ No newline at end of file