Skip to content
This repository has been archived by the owner on Jan 4, 2020. It is now read-only.

Commit

Permalink
add README file
Browse files Browse the repository at this point in the history
  • Loading branch information
pinetum committed Jul 11, 2016
1 parent 7fb3a31 commit 9b0b6b6
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@

AirUnlock (Mac)
===================================
<img src="screenshots/mbp-un_square.png" height="300" alt="Screenshot"/>

Introduction
------------
Establish a connection with your Mac via Bluetooth low-energy (BLE), wireless control Mac lock state (Lock or Unlock).
#### Features
- Store the password in Mac system keychain
- Send the UUID for lock/unlock Macbook (other people can't control your mac)
- With out any internet access
- Authorization with fingerprint
- Wake and unlock whebn mac is sleeping (can not work when first boot-up and manually lock by clicking your name on the status bar and then clicking 'Login Window....')
- Unlock when you resume Mac by pressing a key
- Unlock when you manually lock mac with clicking "lock screen" by keychain access in status bar [(Choose Keychain Access > Preferences, then click General. Select Show keychain status in menu bar.)](https://support.apple.com/kb/PH20121?viewlocale=en_US&locale=en_US)



Requirement
--------------
- Bluetooth 4.0+ both on Mac and Android mobile
- Mac OS X 10.10+ or MacOS 10.12
- Android 5.0+


Getting Started
---------------
- [Download AirUnlock for MacOS](https://github.com/pinetum/AirUnlock-for-Mac/releases/download/0.4/AirUnlock_mac_0.4.zip) ([or build from source](https://github.com/pinetum/AirUnlock-for-Mac))
- [Download AirUnlock Android client](https://github.com/pinetum/AirUnlock-for-Android/releases/download/1.0/AirUnlock_1.0.zip) ([or build from source](https://github.com/pinetum/AirUnlock-for-Android))
- Launch AirUnlock on mac and turn on Bluetooth
- Set up your passord
- Generate a QR-code for android mobile
- Launch AirUnlock on Android and scan QR-code for first time
- Control buttons will show in Notification

Screenshots
-------------
<img src="screenshots/screenshot1.png" height="400" alt="Screenshot"/>

License
-------
BSD


0 comments on commit 9b0b6b6

Please sign in to comment.