Added README and LICENSE

franciscoamado · Jul 7, 2018 · 0fefe0e · 0fefe0e
1 parent 05d351a
commit 0fefe0e
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 0 deletions.
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Francisco Amado
+
+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,40 @@
+<div align="center"><img src="resources/logo.png"></div>
+
+# Timezones 🕔
+
+This is macOS App for keep tracking of multiple Time Zones. Nothing fancy.
+
+Requires macOS 10.13 or later.
+
+You can download it from the latest release [here](https://github.com/franciscoamado/timezones/releases)
+
+<div align="center">
+  <img src="resources/popover.png">
+  <img src="resources/mainwindow.png">
+</div>
+
+## Features
+
+- [x] Set and Show configurable TimeZones
+
+// TODO:
+
+- [ ] Detect users Location/TimeZone
+- [ ] Interactive World Map View of TimeZones
+- [ ] Change System TimeZone
+- [ ] Sunrise/sunset
+- [ ] Changing StatusBar icon with current time
+- [ ] Weather information
+- [ ] Night mode 😎
+
+## Acknowledgements
+
+This App uses some dependencies to make life more interesting:
+
+* [LaunchAtLogin](https://github.com/sindresorhus/LaunchAtLogin) for easy adding "Launch at Login" funcionality.
+* [ReSwift](https://github.com/ReSwift/ReSwift) for testing out Unidirectional Data Flow.
+
+## Contributing
+
+Open an issue with an idea or a PR with a fix. All help is appreciated.
+
diff --git a/resources/logo.png b/resources/logo.png
diff --git a/resources/mainwindow.png b/resources/mainwindow.png
diff --git a/resources/popover.png b/resources/popover.png