Skip to content

Commit

Permalink
⬆️ required fixes and update icons v2.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
jkharrat committed Apr 20, 2021
1 parent 4072fc7 commit 9380996
Show file tree
Hide file tree
Showing 15 changed files with 368 additions and 299 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# IntelliJ project files
.idea
43 changes: 43 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.0.1] - 2020-04-20

### Added
- Catch failure in response from weatherAPI to display error alert
- Show the city name in the software title
- Initial gitignore and Changelog files

### Changed
- Updated manifest file (tooltip, author full name, author website, description, version bump)
- Force the city name to be transformed to lowercase
- Added a link in plugin to submit a bug report
- Screenshot for readme updated

### Removed
- hidden .idea folder has been deleted

## [2.0.0] - 2020-04-18

### Added
- Possible selection of temperature units (celsius or fahrenheit)
- Set frequency of fetching of data (on push, 10 minutes, 30 minutes, 1 hour)

### Changed
- Select provider drop down list
- Rework the whole script for fetching data while implementing setInterval to get relevant data

### Removed

## [1.0.0] - 2020-04-16
### Added
- Initial structure of plugin
- link to weatherAPI to fetch data
- Inputs provided are API key and City

[1.0.0]: https://github.com/JaouherK/streamDeck-weatherPlugin/releases/tag/v0.5
[2.0.0]: https://github.com/JaouherK/streamDeck-weatherPlugin/releases/tag/v1.0
[2.0.1]: https://github.com/JaouherK/streamDeck-weatherPlugin/releases/tag/v2.0.1
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@

# Description

`Weather` is a plugin that displays a weather condition and temperature. It is connected to weatherApi provider and requires an API Key and a city as required inputs. It has also selection for frequency of fetching and temperature unit.
`Weather` is a plugin that displays the weather condition and the temperature of a given city. It is connected to WeatherApi provider and needs an API Key to connect.

Optionally, you can choose the frequency of fetching updated data and the temperature unit ( Celsius or Fahrenheit).

# Features

- code written in Javascript
- cross-platform (macOS, Windows)
- Property Inspector with multiple UI elements
- Choice of Weather provider
- Choose temperature unit
- choose fetching frequency of the weather data

![](screenshot.png)

Expand All @@ -20,3 +24,5 @@ In the Release folder, you can find the file `com.jk.weather.streamDeckPlugin`.
# Source code

The `Sources` folder contains the source code of the plugin.

<div>Application main icon made by <a href="https://www.flaticon.com/authors/smashicons" title="Smashicons">Smashicons</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div>
Binary file modified Release/com.jk.weather.streamDeckPlugin
Binary file not shown.
10 changes: 5 additions & 5 deletions Sources/com.jk.weather.sdPlugin/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@
}
],
"SupportedInMultiActions": true,
"Tooltip": "Get current weather",
"Tooltip": "Get current weather condition and temperature of a given city",
"UUID": "com.jk.weather.action"
}
],
"SDKVersion": 2,
"Author": "Jaouher",
"Author": "Jaouher Kharrat",
"CodePath": "plugin/main.html",
"Description": "Easily get a preview about the weather",
"Description": "Easily get a preview of the weather condition and the temperature of a given city.",
"Name": "Weather",
"Icon": "resources/pluginIcon",
"PropertyInspectorPath": "pi/main_pi.html",
"URL": "https://jk.com",
"Version": "2.0",
"URL": "https://github.com/JaouherK",
"Version": "2.0.1",
"OS": [
{
"Platform": "mac",
Expand Down
2 changes: 1 addition & 1 deletion Sources/com.jk.weather.sdPlugin/pi/main_pi.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@

<div class="sdpi-item">
<button class="sdpi-item-value" onclick="openPage('weatherapi.com/my/')">Get my API key</button>
<button class="sdpi-item-value" onclick="openPage('github.com/JaouherK/streamDeck-weatherPlugin')">GitHub
<button class="sdpi-item-value" onclick="openPage('github.com/JaouherK/streamDeck-weatherPlugin/issues/new?assignees=JaouherK&labels=bug&template=bug_report.md&title=Bug+report')">Report bug
</button>
</div>
</div>
Expand Down
Loading

0 comments on commit 9380996

Please sign in to comment.