diff --git a/README.md b/README.md new file mode 100644 index 0000000..b33cf04 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Connection Indicator +A very small library to implement a connection indicator view. These connections may be GPS, Network or other loading indicators. + +This is only an initial version of the library and I will be making improvements as I go. + +At the moment there aren't any attribute setters in code. All attributes must be set via XML. + + + +There are two `animTypes`: + + - flash = Alternates between connection level of 0 and max. + - incremental = Each bar is turned solid in turn until all are solid and then it goes back to 0. + +To begin search mode: + + indicatorView.startSearching(); + +To stop searching: + + indicatorView.stopSearching(); + +To display a certain "connection level" call the following: + + indicatorView.displayConnectionLevel( 2 );