Skip to content

Commit 347c053

Browse files
author
Dmitry Antonov
committed
update README
1 parent 4138bde commit 347c053

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
1+
<p align="center"><img width="100" src="https://raw.githubusercontent.com/DmtryJS/weather_widjet/feature/vue-components/static/img/weather.ico" alt="logo"></a></p>
2+
<h2 align="center">JustWeather</h2>
3+
14
Weather widget for PC
25
-----------------------------------
36

47
Hi, this is a simple weather widget, is an experiment to try [Electron](https://electronjs.org/) and [Vue Js](https://vuejs.org/).
58
The widget uses a free API [Openweathermap](https://openweathermap.org/). The idea is that the application should be
69
cross-platform, as it is written using Node JS, but I tried it only on Windows 8 & 10
710

8-
### Install and starting
11+
### Uses without developing stuff
12+
13+
You need to download the compiling version. You also need to register on https://openweathermap.org/appid site to get a free token to use this application.
14+
15+
### Developing
916

10-
You should already have [Node JS](https://nodejs.org/en/)
11-
You will need a special key, which can be obtained free of charge from the weather service
12-
<https://openweathermap.org/appid>
17+
You should already have [Node JS](https://nodejs.org/en/)
1318

1419
```bash
1520
git clone https://github.com/DmtryJS/weather_widjet.git
1621
cd weather_widjet
1722
npm install
18-
npm start //start application
23+
npm run start //start application in developer mode with live reload
1924
```
2025
click to icon in tray -> settings -> Application token
2126
Insert your security key from <https://openweathermap.org/appid>
@@ -26,7 +31,7 @@ By default package.json contains windows ready build config. After the build, a
2631
The application icon appears on the desktop.
2732

2833
```bash
29-
npm run dist
34+
npm run build
3035
```
3136

3237
### Screenshots

package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
{
22
"name": "JustWeather",
3+
"author": {
4+
"name": "Dmtry Antonov",
5+
"email": "[email protected]"
6+
},
37
"version": "1.0.0",
48
"description": "Simple weather widget",
59
"main": "index.js",

0 commit comments

Comments
 (0)