Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

README.markdown update

  • Loading branch information...
commit 3debcb061953084c91e40f2621dd6028322c7e66 1 parent 680ea71
@jgilfelt authored
Showing with 7 additions and 3 deletions.
  1. +0 −2  AndroidManifest.xml
  2. +7 −1 README.markdown
View
2  AndroidManifest.xml
@@ -3,7 +3,6 @@
android:versionCode="1"
android:versionName="1.0" package="com.readystatesoftware.viewbadger">
<uses-sdk android:minSdkVersion="4" />
-
<application android:icon="@drawable/icon" android:label="@string/app_name">
<activity android:name="viewbadger.demo.DemoActivity"
android:label="@string/app_name">
@@ -12,6 +11,5 @@
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
-
</application>
</manifest>
View
8 README.markdown
@@ -7,18 +7,24 @@ A simple way to "badge" any given Android view at runtime without having to cate
![ListAdapter](http://jeffgilfelt.com/viewbadger/badge2.png "ListAdapter")&nbsp;
![Layout Tests](http://jeffgilfelt.com/viewbadger/badge3.png "Layout Tests")
+Note: If your aim is to replicate the iOS icon and TabBar badge UI for notifications, consider using Android UI conventions such as the number field of the '[Notification]'(http://developer.android.com/reference/android/app/Notification.html "Notification") class rather than this method.
+
Usage
-----
+Simple example:
+
View target = findViewById(R.id.target_view);
BadgeView badge = new BadgeView(this, target);
badge.setText("1");
badge.show();
+This project contains a fully working example application. Refer to the `DemoActivity` class for more custom badge examples, including custom backgrounds and animations. `BadgeView` is a subclass of `TextView` so you can use all of `TextView`'s methods to style the appearance of your badge.
+
Implementation
--------------
-TODO
+To use ViewBadger in your own Android project, simply copy `android-viewbadger.jar` (available from this repository's downloads) into your project's `libs` directory and add it to the build path.
<br />
Please sign in to comment.
Something went wrong with that request. Please try again.