Merge pull request #3 from johndbritton/readme-and-license

Add a readme and license
johndbritton · Dec 26, 2020 · cfd7bd5 · cfd7bd5
2 parents 886ea9e + 9b2ec5e
commit cfd7bd5
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 0 deletions.
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 John Britton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,24 @@
+# Horologe
+## A timepiece for macOS Notification Center
+
+### About
+
+Horologe provides a digital clock widget for the macOS Notification Center because the built in Clock app only supports analog clocks.
+
+### Installation
+
+Download the [latest release](https://github.com/johndbritton/horologe/releases/latest), uncompress, drag `Horologe.app` to `/Applications`. Then, launch `Horologe.app`.
+
+![Application Screenshot](https://user-images.githubusercontent.com/123345/103148327-81fe6c80-472c-11eb-94f1-24802762a285.png)
+
+You may now quit the application.
+
+__NOTE:__ You must open `Horologe.app` at least once for the widget to become available.
+
+Next, open Notification Center and click the "Edit Widgets" button all the way at the bottom of the list. Select the Horologe widget
+
+![Widget Selection Screenshot](https://user-images.githubusercontent.com/123345/103148890-9b0a1c00-4732-11eb-9441-74cfdba41108.png)
+
+You have successfully installed the widget.
+
+![Widget Screenshot](https://user-images.githubusercontent.com/123345/103148354-bb36dc80-472c-11eb-8d63-be7e9797f846.png)