README.md 3.86 KB
Newer Older
Simon Xu's avatar
Simon Xu committed
1
2
# WhatsApp Stickers

3
4
5
6
![Works with Android](https://img.shields.io/badge/Works_with-Android-green?style=flat-square)
![Works with iOS](https://img.shields.io/badge/Works_with-iOS-blue?style=flat-square)
![GitHub issues](https://img.shields.io/github/issues/whatsapp/stickers?style=flat-square)

Marvin Wendt's avatar
Marvin Wendt committed
7
8
> This repository contains the iOS and Android sample apps and API for creating third party sticker packs for WhatsApp.

Marvin Wendt's avatar
Marvin Wendt committed
9
If you'd like to create your own [stickers for WhatsApp](https://faq.whatsapp.com/en/android/26000227/), you can package them in an Android or iOS app. You can publish your sticker app like any other app to the [Google Play Store](https://play.google.com/store) or [Apple App Store](https://www.apple.com/ios/app-store/), and users who download and install your app will be able to start sending those stickers right away from within WhatsApp. **Stickers on WhatsApp must be legal, authorized and acceptable.** Learn more about acceptable uses of our services from our [Terms of Service](https://www.whatsapp.com/legal/#terms-of-service).
Simon Xu's avatar
Simon Xu committed
10

Marvin Wendt's avatar
Marvin Wendt committed
11
12
## Get started :rocket:

Marvin Wendt's avatar
Marvin Wendt committed
13
To get started, review the `README` files in the [Android](https://github.com/WhatsApp/stickers/tree/master/Android) or [iOS](https://github.com/WhatsApp/stickers/tree/master/iOS) folders, and refer to the [FAQ](https://faq.whatsapp.com/general/26000226).
Simon Xu's avatar
Simon Xu committed
14

15
16
17
18
19
20
## PLEASE READ: IMPORTANT NOTICE ABOUT iOS APPS

With Apple’s strict App Store review policy, we recommend iOS developers to submit apps that contain more functionality than to simply export stickers. This will increase the chances of the app being accepted. As an alternative to creating an iOS app, there are various sticker maker apps that help you create and import stickers into WhatsApp.

The sample iOS app is an example on how to use our API to import stickers into WhatsApp, and can serve as guide on how to get started, but it is not meant to be used as template for your app because it will not be accepted by Apple.

Simon Xu's avatar
Simon Xu committed
21
## Announcements :loudspeaker:
Dr.Mo's avatar
Dr.Mo committed
22
Please check out [Announcements](https://github.com/WhatsApp/stickers/wiki/Sticker-Updates:-September-30,-2019) for recent changes.
Simon Xu's avatar
Simon Xu committed
23

Simon Xu's avatar
Simon Xu committed
24
25
26
## Brand guidelines
When naming your app, it is strongly advised you do not use "WhatsApp" anywhere in the name of your app or in the name field of your app listing. However, when preparing your app for submission in Google Play Store/App Store, you'll have the option to add description associated with your app and it's okay to mention WhatsApp in the description. Make sure you use "WhatsApp" as brand name, with "W" and "A" capitalized with no space between letters. More information on WhatsApp Brand(https://whatsappbrand.com/).

Marvin Wendt's avatar
Marvin Wendt committed
27
## Opening Issues :warning:
Marvin Wendt's avatar
Marvin Wendt committed
28
29

> Only use the GitHub Issues section if you discovered **issues with the code itself**. Do not mistake the Issues page as a help desk. You can ask for help at [Stack Overflow](https://stackoverflow.com/).  
Marvin Wendt's avatar
Marvin Wendt committed
30
> For support, please contact <developer@support.whatsapp.com>.
31

Marvin Wendt's avatar
Marvin Wendt committed
32
33
34
- Create an [**Android**](https://github.com/WhatsApp/stickers/issues/new?template=android.md) issue
- Create an [**iOS**](https://github.com/WhatsApp/stickers/issues/new?template=ios.md) issue
- Create a [**general issue**](https://github.com/WhatsApp/stickers/issues/new?template=general.md)
35

Marvin Wendt's avatar
Marvin Wendt committed
36
_For all three options, fill in all fields that apply._
37

Marvin Wendt's avatar
Marvin Wendt committed
38
39
40
41
## Opening Pull Requests

> In order for us to accept pull requests, please complete the Contributor License Agreement by following instructions in [`CONTRIBUTING`](https://github.com/WhatsApp/stickers/blob/master/CONTRIBUTING.md).

Marvin Wendt's avatar
Marvin Wendt committed
42
1. Please check that a similar pull request doesn't exist already [here](https://github.com/WhatsApp/stickers/pulls?utf8=%E2%9C%93&q=is%3Apr)
Marvin Wendt's avatar
Marvin Wendt committed
43
44
45
2. [Open a new pull request](https://github.com/WhatsApp/stickers/compare)
3. Wait for someone to look at it :watch:

Simon Xu's avatar
Simon Xu committed
46
## License
Marvin Wendt's avatar
Marvin Wendt committed
47

48
WhatsApp Stickers is BSD licensed, as found in the [`LICENSE`](https://github.com/WhatsApp/stickers/blob/master/LICENSE) file.