Skip to content

Fix broken image links, add banner, and clean up text on README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
edwinfinch wants to merge 1 commit into
base: master
Choose a base branch
from
+35 −17
Open

Fix broken image links, add banner, and clean up text on README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 35 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,39 @@
# pebble-timer
Simple pebble timer built to be published by Pebble in the store.

![alt Timer Menu](https://github.com/pebble/pebble-timer/blob/release-1.0/assets/Menu.png)
![alt Timer Setting](https://github.com/pebble/pebble-timer/blob/release-1.0/assets/Setting 1.png)
![alt Timer Detail](https://github.com/pebble/pebble-timer/blob/release-1.0/assets/Bubbles.png)
![alt Timer Pin](https://github.com/pebble/pebble-timer/blob/release-1.0/assets/Pin.png)

Timers appear in a list on the main screen. Add a timer via the "+" icon at the top of the list similarly
to the alarm app. When setting a timer, the time the timer will end is displayed under the entry fields if
the timer duration is greater than 15 minutes. Also, the timer will send a pin to the timeline if the duration
is greater than 15 minutes. A detailed view of the timer can be accessed by either selecting one of the
menu items on the main screen, or by choosing "Open timer" in the pin's action menu. In the detailed view,
the timer can be played and paused as well as edited and deleted.

If the app is closed out, it will automatically open and vibrate when a timer goes off. From this timer ended
screen, the user can dismiss the timer or snooze the timer. The former will leave it as a paused timer in
the menu window, and the latter will roll the timer back one minute.

![alt Timer Banner](assets/timer-banner-main.png)

## About
Home of the original timer published by Pebble in the [Pebble App Store](https://apps.repebble.com/timer_55b6cd955e0716cd6b0000a1).

## Functionality

### Add and view timers

![alt Timer Menu](assets/Menu.png)
![alt Timer Detail](assets/Detail.png)

Timers appear in a list on the main screen. Add a timer via the "+" icon at the top of the list, similar to the alarm app.

A detailed view of the timer can be accessed by either selecting one of the menu items on the main screen, or by choosing "Open timer" in the pin's action menu. In the detailed view, the timer can be played and paused as well as edited and deleted.

### Completion time

![alt Timer Setting](assets/Setting%202.png)

If when setting the timer the duration is greater than 15 minutes, the completion time of the timer will be displayed displayed under the entry fields.

### Automatic timeline pins
![alt Timer Pin](assets/Pin.png)

The timer will send a pin to the timeline if the duration is greater than 15 minutes.

### Wake API

![alt Timer Detail](assets/Vibrating.png)

If the app is closed out, it will automatically open and vibrate when a timer goes off.

From this timer ended screen, the user can dismiss the timer or snooze the timer. The former will leave it as a paused timer in the menu window, and the latter will roll the timer back one minute.

## Changelog

Expand Down