Submission Guidelines

We are putting together a collection of community resources for a new section on the Pebble Developer Website, and we need your contributions!

There are three types of content we are looking for:

• Example Apps
• Developer Tools
• Libraries

To add your resource to the collection, simply fork this GitHub repository, follow the relevant guide below to create a Markdown file in the right folder, and submit a pull request.

You can also take a look at some of the resources that have already been submitted to see how to do it.

Example Apps

We are looking for well-written apps that other people can use to learn Pebble development.

NOTE: You must provide an open-source license for your apps in order for it to be approved. The best way to do that is to include a LICENSE file in your app repository. Indicate the license you have selected in the metadata block of your Markdown file.

To add your app, create a new Markdown file in the correct folder with the same name as your app (in a URL friendly style, such as multi-timer.md or uk-transport.md). Examples:

apps/multi-timer.md
apps/uk-transport.md

At the top of your Markdown file you will need to have a metadata block that contains the following properties:

---
name: Multi Timer
creator: Matthew Tole
license: mit
link: https://github.com/smallstoneapps/multi-timer/
appstore: 52bda40bdc2f4f552e000089
tags:
  - watchapp
  - js
  - storage
---

Hopefully name, creator and link are self-explanatory. The appstore entry is the Pebble appstore ID for your app. If your app isn't on the Pebble appstore, omit this line. The tags list will be used on the site to let people browse by different tags. See below for the list of all of the possible tags.

Below this metadata block you should write a description of your app. Include details of the key features it has.

Tags

These are all the possible tags for your app. If you think a tag should be added to the list, get in touch with us using the contact form.

Developer Tools

To add your tool, create a new Markdown file in the correct folder with the same name as your tool, in a URL-friendly style, such as pebble-local-simulator.md or watchface-generator.md. Examples:

tools/pebble-local-simulator.md
tools/watchface-generator.md

At the top of your Markdown file, you will need to have a metadata block that contains the following properties.

---
name: Watchface Generator
creator: Paul Rode
link: http://watchface-generator.de
---

Below this metadata block you should write a description of your tool.

Libraries

NOTE: You must provide an open-source license for your library in order for it to be approved. The best way to do that is to include a LICENSE file in the repository for your library. Indicate the license you have selected in the metadata block of your Markdown file.

To add your library create a new Markdown file in the libraries folder with the same name as your library, in a URL-friendly style, such as js-message-queue.md or clock-layer.md. Examples:

libraries/clock-layer.md
libraries/js-message-queue.md

At the top of your Markdown file you will need to have a metadata block that contains the following properties.

---
name: JS Message Queue
creator: Matthew Tole
license: mit
link: https://github.com/smallstoneapps/js-message-queue/
language: js
---

The language property should be one of c, js, android, or ios. This will help people find your library.

Below the metadata block you should write a description of your library. Talk about what problem it aims to solve and how people should use it.