Skip to content

Commit

Permalink
Merge pull request #686 from hovancik/release
Browse files Browse the repository at this point in the history
Release Stretchly 1.1.0
  • Loading branch information
hovancik authored Sep 12, 2020
2 parents 012c8a2 + 6f58689 commit 3be780f
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Issue: #

<!-- If there’s a checkbox you can’t complete for any reason, that's okay, just explain in detail why you weren’t able to do so. -->

- [ ] issue was opened to discuss proposed changes before starting implementation.
- [ ] issue was opened to discuss proposed changes before starting implementation. It is important do discuss changes before implementing them (Why should we add it? How should it work? How should it look? Where will it be? ...).
- [ ] during development, `node` version specified in `package.json` was used (ie using [nvm](https://github.com/creationix/nvm)).
- [ ] package versions and package-lock.json were not changed (`npm install --no-save`).
- [ ] app version number was not changed.
Expand Down
9 changes: 6 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]

## Added
## [1.1.0] - 2020-09-12

### Added
- show Contributor Settings in tray menu for Contributors
- breaks are paused if the Windows 10 Focus Assist mode is enabled
- added log file for debug
Expand All @@ -18,7 +20,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- updated Polish translation
- updated Chinese translations
- bigger range for Mini Break duration
- preferences navigation menu visible when scrolled down
- preferences navigation menu visible when scrolling down

## [1.0.0] - 2020-07-18

Expand Down Expand Up @@ -463,7 +465,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- resume/pause functionality for reminder
- scripts for creating installers for OS X, Windows, Linux

[Unreleased]: https://github.com/hovancik/stretchly/compare/v1.0.0...HEAD
[Unreleased]: https://github.com/hovancik/stretchly/compare/v1.1.0...HEAD
[1.1.0]: https://github.com/hovancik/stretchly/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/hovancik/stretchly/compare/v0.99.5...v1.0.0
[0.99.5]: https://github.com/hovancik/stretchly/compare/v0.99.4...v0.99.5
[0.99.4]: https://github.com/hovancik/stretchly/compare/v0.99.3...v0.99.4
Expand Down
38 changes: 23 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Stretchly [![Humane Tech](https://raw.githubusercontent.com/engagingspaces/awesome-humane-tech/master/humane-tech-badge.svg?sanitize=true)](https://github.com/engagingspaces/awesome-humane-tech) [![Build Status](https://travis-ci.org/hovancik/stretchly.svg?branch=master)](https://travis-ci.org/hovancik/stretchly) [![Build status](https://ci.appveyor.com/api/projects/status/d3eq9bs1kcysulb1?svg=true)](https://ci.appveyor.com/project/hovancik/stretchly) [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) [![codecov](https://codecov.io/gh/hovancik/stretchly/branch/master/graph/badge.svg)](https://codecov.io/gh/hovancik/stretchly) [![Join the chat at https://gitter.im/stretchly/Lobby](https://badges.gitter.im/stretchly/Lobby.svg)](https://gitter.im/stretchly/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# Stretchly [![Awesome Humane Tech](https://raw.githubusercontent.com/humanetech-community/awesome-humane-tech/main/humane-tech-badge.svg?sanitize=true)](https://github.com/humanetech-community/awesome-humane-tech) [![Build Status](https://travis-ci.org/hovancik/stretchly.svg?branch=master)](https://travis-ci.org/hovancik/stretchly) [![Build status](https://ci.appveyor.com/api/projects/status/d3eq9bs1kcysulb1?svg=true)](https://ci.appveyor.com/project/hovancik/stretchly) [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) [![codecov](https://codecov.io/gh/hovancik/stretchly/branch/master/graph/badge.svg)](https://codecov.io/gh/hovancik/stretchly) [![Join the chat at https://gitter.im/stretchly/Lobby](https://badges.gitter.im/stretchly/Lobby.svg)](https://gitter.im/stretchly/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

<img src="stretchly_128x128.png" align="right" alt="Stretchly logo">

Expand Down Expand Up @@ -32,13 +32,17 @@ You can also install *Stretchly* with [Homebrew](https://brew.sh/) by running `b

### Windows

You can install *Stretchly* for all users silently by running this as administrator: `installer.exe /S /allusers`.

You can also install *Stretchly* with [Chocolatey](https://chocolatey.org) by running the following command from the command line or from PowerShell: `choco install stretchly`. Upgrade with `choco upgrade stretchly`.

Stretchly is also available in Microsoft's [winget](https://docs.microsoft.com/en-us/windows/package-manager/winget/).

### Linux note
You can install *Stretchly* for all users silently by running this as administrator: `installer.exe /S /allusers`.

### Linux/BSD/Portable

For portable versions and for Linux/BSD installers, head to [Github Releases page](https://github.com/hovancik/stretchly/releases). The most widely used distributions should be covered.

#### Linux note

Please see http://electron.atom.io/docs/api/tray/ for Electron's Tray Linux specifics. Having `libappindicator1` installed should be enough for *Stretchly*.

Expand Down Expand Up @@ -80,7 +84,7 @@ Clicking the *Stretchly* icon in your tray area will display the current status

<img src="tray.png" height="140">

*Stretchly* is monitoring your idle time, so when you are idle for 5 minutes, breaks will be reset until you return.
*Stretchly* is monitoring your idle time, so when you are idle for 5 minutes, breaks will be paused until you return.

*Stretchly* is also monitoring Do Not Disturb mode, so breaks are paused when DnD mode is On.

Expand All @@ -106,7 +110,7 @@ It's recommended to Quit *Stretchly* before editing the preferences file.

To make sure that all works as expected, it's always good idea to check that format of the preferences file is correct, ie. by using [jsonformatter](https://jsonformatter.curiousconcept.com/).

Some of the extra settings are available in Contributor Preferences for [Contributors](#contributor-preferences). Those are marked by [![GitHub All Releases](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences) badge.
Some of the extra settings are available in Contributor Preferences for [Contributors](#contributor-preferences). Those are marked by [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences) badge.

**Note:** Before 1.0, Mini Breaks and Long Breaks were called Microbreaks and Breaks, respectively. To keep the upgrade smooth they still use that name in preferences file and in code.

Expand All @@ -115,7 +119,7 @@ In the preferences file, change `useIdeasFromSettings: false,` to `useIdeasFromS

Note that when a new *Stretchly* version with new break ideas is out, your custom ideas will not be overwritten.

#### Editing Break notification interval [![GitHub All Releases](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
#### Editing Break notification interval [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)

In the preferences file, change `breakNotificationInterval: 30000,` to whatever value you want. 30000 is 30 seconds. Same goes for Mini Breaks.

Expand All @@ -128,30 +132,34 @@ E.g. if you live in Boston you would set:
`posLatitude: 42.3,`
`posLongitude: 71`

#### Editing postpone functionality [![GitHub All Releases](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
#### Editing postpone functionality [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
In the preferences file, you can edit `microbreakPostpone` and `breakPostpone` to enable or disable the ability to postpone breaks, `microbreakPostponeTime` and `breakPostponeTime` to change the postpone time in milliseconds, `microbreakPostponesLimit` and `breakPostponesLimit` to change the number of allowed postpones per break, and finally, `microbreakPostponableDurationPercent` and `breakPostponableDurationPercent` to change the percentage of the break during which the user can postpone it.

#### New version notification [![GitHub All Releases](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
#### New version notification [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
In the preferences file, set `notifyNewVersion: false,` to disable new version notification.

#### Play sound at the start of the Break [![GitHub All Releases](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
#### Play sound at the start of the Break [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
In the preferences file, set `microbreakStartSoundPlaying: true,` to start a Mini Break with a sound (The same sound will be played as at the end of the break). Same for `breakStartSoundPlaying`.

#### Natural breaks inactivity time [![GitHub All Releases](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
#### Natural breaks inactivity time [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
In the preferences file, set `naturalBreaksInactivityResetTime` to your preferred value (in milliseconds greater than than 20000ms). This is an idle time length, after which *Stretchly* breaks will be paused until the user resumes activity.

#### Volume for break sounds [![GitHub All Releases](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
#### Volume for break sounds [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
In the preferences file, set `volume` to your preferred value. Default value is `1`, which is 100% volume. Set it, for example, to `0.61` for 61% volume.

#### Postpone/Finish Break Shortcut
In the preferences file, set `endBreakShortcut` to your preferred value. We do not validate this input, so please check [Electron's documentation](https://www.electronjs.org/docs/api/accelerator) for available values for key and modifier.

#### Appearance [![GitHub All Releases](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
#### Appearance [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
In the preferences file, change `themeSource: 'system'` to either `'light'` or `'dark'` to always use the specified theme.

#### Welcome window [![GitHub All Releases](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
#### Welcome window [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
To show the Welcome window again on the next start, change `"isFirstRun"` to `true`.

#### Theme transparency [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
To specify how solid the break window should be when Theme transparency is enabled, set the value of `opacity` from `0` to `1` (which is in turn 0 to 100%).


## Contributor Preferences
*Stretchly* is free but you can support it by contributing code or money.

Expand All @@ -164,7 +172,7 @@ You will be rewarded by getting access to extra preferences (+ other perks) avai
## Development
Feel free to join in the [development](https://github.com/hovancik/stretchly/blob/master/CONTRIBUTING.md) of this app via Issues and Pull Requests.

**Before implementing a feature, please open an Issue first, so we can be sure that no one else is working on it and that the changes will be accepted.**
**Before implementing a feature, please open an Issue first, so we can be sure that no one else is working on it and that the changes will be accepted. It is important do discuss changes before implementing them (Why should we add it? How should it work? How should it look? Where will it be? ...).**

### Debugging
If you start *Stretchly* in development mode with the `npm run dev` command, it makes it possible to debug the application in your browser on `http://localhost:9222`.
Expand Down
2 changes: 1 addition & 1 deletion app/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion app/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "Stretchly",
"version": "1.0.0",
"version": "1.1.0",
"description": "The break time reminder app",
"main": "main.js",
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "Stretchly",
"version": "1.0.0",
"version": "1.1.0",
"description": "The break time reminder app",
"main": "app/main.js",
"engines": {
Expand Down

0 comments on commit 3be780f

Please sign in to comment.