README file

README.md

@@ -0,0 +1,35 @@
+# MaterialProgressBar library binding for Xamarin Android
+
+![Icon](art/launcher_icon-web.png)
+
+Material Design `ProgressBar` with consistent appearance on Android 4.0+.
+
+## Why MaterialProgressBar?
+
+- Consistent appearance on Android 4.0+.
+- Correct tinting across platforms.
+- Able to remove the intrinsic padding of framework `ProgressBar`.
+- Able to hide the progress background of framework horizontal `ProgressBar`.
+- Used as a drop-in replacement for framework `ProgressBar`.
+
+See [MaterialProgressBar library repository](https://github.com/DreaminginCodeZH/MaterialProgressBar/) for more details.
+
+## Binding and sample code
+
+Library binding is using MaterialProgressBar AAR package v1.3.0.
+
+Sample code is based on MaterialProgressBar sample code and its resources. [Butter Knife](https://github.com/JakeWharton/butterknife) library was replaced with [Cheeseknife](https://github.com/MisterJimson/Cheeseknife).
+
+## Usage
+
+* Download this repository and add reference to `MaterialProgressBar` project in your solution
+
+or 
+
+* Install [ZhangHai.Android.MaterialProgressBar](https://www.nuget.org/packages/ZhangHai.Android.MaterialProgressBar/) package from nuget.org
+
+## License
+
+[MaterialProgressBar](https://github.com/DreaminginCodeZH/MaterialProgressBar/) is licensed under the Apache License, Version 2.0.
+
+Source code from this repository is licensed under the Apache License, Version 2.0. See LICENSE file.