Merge branch 'main' of https://github.com/SKemenov/MinimalCountdown

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/macos-bug-report.md

@@ -0,0 +1,32 @@
+---
+name: MacOS Bug report
+about: Create a report to help us improve
+title: "[BUG] "
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+- Device: [e.g. MacBookPro]
+- macOS: [e.g. Sonoma or 15.1]
+- Locale: [e.g. English, Spanish]
+
+**Additional context**
+Add any other context about the problem here.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Sergey Kemenov
+
+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.

README.md

@@ -1,8 +1,11 @@
 ## Minimal Countdown (macOS)
 
-Minimal Countdown is a minimalistic countdown screen saver for macOS. Shows the timer while you take a rest for awhile. 
+Minimal Countdown is a minimalistic countdown screen saver for macOS. Shows the timer while you take a rest for a while. 
 
-![Screenshot](vendors/screenshot.png)
+![Screenshot](vendors/mc-screenshot-01s.png)
+![Screenshot](vendors/mc-screenshot-03s.png)
+![Screenshot](vendors/mc-screenshot-04s.png)
+![Screenshot](vendors/mc-screenshot-05s.png)
 
 
 ## Features
@@ -16,32 +19,47 @@ Minimal Countdown is a minimalistic countdown screen saver for macOS. Shows the
 - [x] Select a style for your timer to display days, hours, minutes and even seconds
 - [x] Localization - English
 
-## Configurations
-![Configurations](vendors/configurations.png)
-
 ## Compatibility
 Minimal Countdowns screen saver requires OS X Ventura or later.
 
 
 ## Stack 
 `Swift only`, `no storyboards`, `AppKit`, `ScreenSaver`, `ScreenSaverDefaults`
 
-<!---
 ## Downloads
-### [Screen Saver](Releases/1.8/screensaver.zip)
-Double-click to install.
---->
+### [Minimal Countdown Screen Saver (.zip)](https://github.com/SKemenov/MinimalCountdown/releases/download/1.0/MinimalCountdown.saver.zip)
+
+## Configurations
+![Configurations](vendors/mc-screenshot-02s.png)
 
+
+## How to install
+1. Download zip file, unzip it and double-click `MinimalCountdown.ssaver`
+2. You can choose to install this screen saver only into your account or for all users
+3. Close `System Settings` and reopen it
+4. My current build is not yet notarized so you may see macOS notification _"MinimalCountdown.saver can’t be opened because Apple cannot check it for malicious software."_
+5. To fix this issue click `Show in Finder` button, macOS opens `Screen Savers` folder in the Finder
+6. Click `Ok` to close the notification alert and `System Settings` window too
+7. Hold `Shift` and after that right-click `MinimalCountdown.ssaver` file, then select `Open` in the context menu
+8. In the new notification window please click `Open` button
+9. Customize the settings to fit your imagination
+10. Enjoy it!
+
+**Note:**
+If you doubt about this issue, you may clone my repo and try to build the screen saver by yourself.
+
+<!---
 ## How to build
 1. Clone the git
 2. Open the project in Xcode and build it
 3. Make an archive and take `MinimalCountdown.ssaver` from there 
 4. Double-click `MinimalCountdown.ssaver` file to add it into the `System Settings`
+--->
 
 ## How to re-install
 1. Delete screen saver in `System Settings` (right-click && `Delete "MinimalCountdown"` && `Move to Trash`)
 2. Close `System Settings` window
-3. Restart WallpaperAgent `killall kill WallpaperAgent` via the Terminal
+3. Restart WallpaperAgent `killall kill WallpaperAgent` via the Terminal (or just restart you computer)
 4. Install the new version of `MinimalCountdown.ssaver`