Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nicktoumpelis committed Aug 8, 2015
1 parent 1736782 commit a8c80ea
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
@@ -1,9 +1,11 @@
HiBeacons
=========
**A Swift demo app for the iBeacons API in iOS 8**
**A Swift demo app for the iBeacons API in iOS 8, with Apple Watch support**

HiBeacons is a fully functional demo app for the iBeacons API in iOS 8, written in Swift. The app can be used to demonstrate beacon region monitoring, advertising and ranging, simply by toggling on/off three switches in the UI.

The app also supports the Apple Watch, and implements a basic interface for starting all the operations from a WatchKit app. (The watch app acts as a dumb* remote).

The source is easy to understand and modify. The structure of the app is based on a simple hierarchy of operation classes. There are three `NATOperation` subclasses, each responsible of a specific operation: `NATMonitoringOperation`, `NATAdvertisingOperation`, and `NATRangingOperation`. The app is easy to use with any given proximity UUID and identifier, which can be changed in `NATOperation`.

The app is fully documented, using the reStructuredText standard, which SourceKit can parse.
Expand All @@ -13,7 +15,10 @@ The main branch of the project is the *swift* branch, but you can still find the
*The app is fully documented, and should compile with Xcode 6.4 and work correctly on iOS 8.*

## Screenshot
![Screenshot](https://raw.github.com/nicktoumpelis/HiBeacons/swift/screenshot.png)

![Screenshot](https://github.com/nicktoumpelis/HiBeacons/blob/swift/screenshot.png)

![Watch-Screenshot](https://github.com/nicktoumpelis/HiBeacons/blob/swift/watch-screenshot.png)

## Notes

Expand All @@ -24,6 +29,8 @@ The main branch of the project is the *swift* branch, but you can still find the
- Major and minor integers are generated randomly every time a new advertising session starts.
- You can find and set the UUID and identifier for the region in `NATOperation.swift`.

\* The Watch app can trigger actions on the device, but cannot reflect the state of the device, yet.

## Contact

[Nick Toumpelis](http://github.com/nicktoumpelis) ([@nicktoumpelis](https://twitter.com/nicktoumpelis))
Expand Down
Binary file added watch-screenshot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a8c80ea

Please sign in to comment.