diff --git a/README.md b/README.md index e5b0667..0e03e50 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,53 @@ An Android library for drawing gauges on Canvas. ![GaugeView](http://goo.gl/Hu7Ou) +## Usage -TODO (coming soon) ------------------- +Import the library into your project. -Clean up the code. +Configuration takes place via XML: *interaction via code is largely limited to updating the value the gauge will display.* -Document the main features. +In your layout XML file add/configure the GaugeView(s) as shown: -Add javadoc. \ No newline at end of file +```xml + + + +``` + +Interact with the GaugeView: + +```java +private GaugeView mGaugeView1; +private GaugeView mGaugeView2; + +// Retrieve the references +mGaugeView1 = (GaugeView) findViewById(R.id.gauge_view1); +mGaugeView2 = (GaugeView) findViewById(R.id.gauge_view2); + +// Set the values to display +mGaugeView1.setTargetValue(25); +mGaugeView2.setTargetValue(35); +``` + +## TODO (coming soon) + +- [ ] Clean up the code. + +- [ ] Document the main features. + +- [ ] Add javadoc.