README.md
1 Android Wearable Notifications Sample
2 ===================================
3
4 This sample showcases the available notification styles on a device and wearable.
5
6 Introduction
7 ------------
8
9 This sample app enables the user to choose a notification type (the selection is done on the phone),
10 which it then displays on the phone and wearable. The notification is built using
11 [NotificationCompat.Builder][1] and [NotificationCompat.WearableExtender][2].
12
13 See [Creating a Notification][3] for all the details on how to create a notification with wearable features.
14
15 On the wearable side, the sample also shows how to create a custom layout using [WearableListView][4].
16
17 [1]: http://developer.android.com/reference/android/support/v4/app/NotificationCompat.Builder.html
18 [2]: https://developer.android.com/reference/android/support/v4/app/NotificationCompat.WearableExtender.html
19 [3]: https://developer.android.com/training/wearables/notifications/creating.html
20 [4]: https://developer.android.com/training/wearables/apps/layouts.html#UiLibrary
21
22 Pre-requisites
23 --------------
24
25 - Android SDK v21
26 - Android Build Tools v21.1.1
27 - Android Support Repository
28
29 Screenshots
30 -------------
31
32 <img src="screenshots/companion-content-action.png" height="400" alt="Screenshot"/> <img src="screenshots/content-action" height="400" alt="Screenshot"/> <img src="screenshots/content-icon-menu" height="400" alt="Screenshot"/>
33
34 Getting Started
35 ---------------
36
37 This sample uses the Gradle build system. To build this project, use the
38 "gradlew build" command or use "Import Project" in Android Studio.
39
40 Support
41 -------
42
43 - Google+ Community: https://plus.google.com/communities/105153134372062985968
44 - Stack Overflow: http://stackoverflow.com/questions/tagged/android
45
46 If you've found an error in this sample, please file an issue:
47 https://github.com/googlesamples/android-Wearable Notifications
48
49 Patches are encouraged, and may be submitted by forking this project and
50 submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
51
52 License
53 -------
54
55 Copyright 2014 The Android Open Source Project, Inc.
56
57 Licensed to the Apache Software Foundation (ASF) under one or more contributor
58 license agreements. See the NOTICE file distributed with this work for
59 additional information regarding copyright ownership. The ASF licenses this
60 file to you under the Apache License, Version 2.0 (the "License"); you may not
61 use this file except in compliance with the License. You may obtain a copy of
62 the License at
63
64 http://www.apache.org/licenses/LICENSE-2.0
65
66 Unless required by applicable law or agreed to in writing, software
67 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
68 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
69 License for the specific language governing permissions and limitations under
70 the License.
71