diff options
Diffstat (limited to 'libraries/Android-AppMsg/README.md')
| -rw-r--r-- | libraries/Android-AppMsg/README.md | 117 |
1 files changed, 0 insertions, 117 deletions
diff --git a/libraries/Android-AppMsg/README.md b/libraries/Android-AppMsg/README.md deleted file mode 100644 index 7f8006998..000000000 --- a/libraries/Android-AppMsg/README.md +++ /dev/null @@ -1,117 +0,0 @@ -Android AppMsg (Crouton) Library -================================ - -Implementation of in-layout notifications. Based on [Toast](http://developer.android.com/reference/android/widget/Toast.html) notifications and article [The making of Prixing #4: in-layout notifications](http://android.cyrilmottier.com/?p=773) by [Cyril Mottier](http://www.cyrilmottier.com/). - - -Description ------------ - -Toast is far from being perfect and I am not entirely satisfied with it. -Toast can be un-accurate in some cases. Indeed, Toast has one major drawback: it completely breaks contexts. -This issue can be reproduced effortless. Let’s say a user is currently in an app firing a Toast and wants to switch to another application using the dedicated “multitask” button. -The Toast will remain on screen even if the brought-to-front application has nothing do to with the previously shown app as described on the following figure: -![Example Image][1] - -As you can easily notice, the problem with Toasts is they are persistent. -Once a Toast has been fired, it is displayed on top of any screen and remains visible for the duration specified at its creation. - -In order to bypass the Toast persistence problem and ensure information is displayed in the correct context, we decided to create a new notification system: -Activity-bound notifications. This is what it looks like in the current version of Prixing: -![Example Image][2] - -Crouton overcomes the main issue of having a Toast being shown while the menu is open. -It sticks to the current screen sliding with it and leaving the menu completely free of any information that would have not been related to it. - -<b>Copyright (C) by Cyril Mottier</b> - -Sample ------- - -A sample application is available on Google Play: - -<a href="http://play.google.com/store/apps/details?id=com.devspark.appmsg.sample"> - <img alt="Get it on Google Play" - src="http://www.android.com/images/brand/get_it_on_play_logo_small.png" /> -</a> - -![Example Image][3] - -The source code is available in this repository. - -Compatibility -------------- - -This library is compatible from API 4 (Android 1.6). - -Installation ------------- - -The sample project requires: - -* The library project -* [ActionBarSherlock](https://github.com/JakeWharton/ActionBarSherlock) - -Usage ------ - -Android AppMsg is presented as an [Android library project](http://developer.android.com/guide/developing/projects/projects-eclipse.html). -You can include this project by [referencing it as a library project](http://developer.android.com/guide/developing/projects/projects-eclipse.html#ReferencingLibraryProject) in Eclipse or ant. - -To display the item you need the following code: - -* Show AppMsg: - -``` java -AppMsg.makeText(/*Activity*/, /*CharSequence*/, /*AppMsg.Style*/).show(); -``` - -Gradle ------- - -Android-AppMsg Library is now pushed to Maven Central as a AAR, so you just need to add the following dependency to your build.gradle. - -``` xml -dependencies { - compile 'com.github.johnkil.android-appmsg:appmsg:1.2.0' -} -``` - -Example Gradle project using Android-AppMsg: - -* [Android-AppMsg-Gradle-Sample](https://github.com/johnkil/Android-AppMsg-Gradle-Sample) - - -Contribution ------------- - -Please fork [dev](https://github.com/johnkil/Android-AppMsg/tree/dev) repository and contribute back using [pull requests](https://github.com/johnkil/Android-AppMsg/pulls). - -Contributors are recommended to follow the Android [Code Style Guidelines](http://source.android.com/source/code-style.html). - -Any contributions, large or small, major features, bug fixes, additional language translations, unit/integration tests are welcomed and appreciated but will be thoroughly reviewed and discussed. - -Developed By ------------- -* Evgeny Shishkin - <johnkil78@gmail.com> - -License -------- - - Copyright 2012 Evgeny Shishkin - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -[1]: http://cyrilmottier.com/media/2012/07/the-making-of-prixing-4-activity-tied-notifications/toast_user_flow_fail.png -[2]: http://cyrilmottier.com/media/2012/07/the-making-of-prixing-4-activity-tied-notifications/in_layout_notification.png -[3]: http://i46.tinypic.com/21kywit.png |