diff --git a/README.md b/README.md index 6c9b9ee..6e44ebe 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # macos_unlock +The handy, dandy unlocker for macOS. + +# Setup + +All you need to do is to install the php and ApplScript file in the same location on a PHP enabled web server and edit in that location a "password.txt" file with your password. + +Keep in mind, you migght need to grant a buncha permissions to the web server and PHP to execute scripts. + +# Calling the URL + +There's many ways one can initiate the call to unlock.php on your webserver. One such way that I use is an NFC chip with a URL data point set on it. When I scan with my Android device, it will call the unlock, do the action, and load the finished screen. It just works (tm)! + +# Security Considerations + +This will grant access to malicious individuals potentially, so make sure everything is secure, including not exposing the webserver outside your network. +