Skip to content

Commit d51036d

Browse files
committed
📝 update README.md
1 parent 8e81739 commit d51036d

File tree

4 files changed

+32
-13
lines changed

4 files changed

+32
-13
lines changed

README.md

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,43 @@
1-
# spring-vue
1+
![Spring windows](./cover.png)
22

3-
## Project setup
3+
<center>
4+
5+
Spring is an Excel file viewer and analyzer. It allows you to filter your `.xslx` documents and generate charts based on the data contained in the documents. The app was developed for a project by Josef Vacek, who also provided the funding for the development of this app.
6+
7+
</center>
8+
<br>
9+
<br>
10+
<br>
11+
<br>
12+
13+
## Installation
14+
Download the package for your OS and install or unzip the application.
15+
16+
17+
<br>
18+
19+
## Development
20+
The app uses [Vue CLI Plugin Electron Builder](https://nklayman.github.io/vue-cli-plugin-electron-builder/) thus can be developed as any other JavaScript application.
21+
22+
### Project setup
23+
First, it is necessary to install all Node packages, thus run:
424
```
525
npm install
626
```
727

8-
### Compiles and hot-reloads for development
28+
#### Compiles and hot-reloads for development
29+
To preview the app during the development following command could be used:
930
```
10-
npm run serve
31+
npm run electron:serve
1132
```
1233

1334
### Compiles and minifies for production
35+
Before making PR, please try to build the app and run it again as some bugs can appear after building the application.
1436
```
15-
npm run build
37+
npm run electron:build
1638
```
1739

18-
### Lints and fixes files
19-
```
20-
npm run lint
21-
```
40+
<br>
2241

23-
### Customize configuration
24-
See [Configuration Reference](https://cli.vuejs.org/config/).
42+
## Contributions
43+
All contributions are welcomed, however give me some time to review your requests.

cover.png

81.8 KB
Loading

src/translations/cs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
},
1818
"document": {
1919
"create_filter": "Přidat filtr",
20-
"search_placeholder": "Vyhledávat, \"heslo\" upřesňuje vyhledávání",
20+
"search_placeholder": "Použijte \"uvozovky\" pro přesné hledání",
2121
"show_columns": "zobrazit sloupce",
2222
"modal": {
2323
"show_columns": "Zobrazit sloupce"

src/translations/en.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
},
1616
"document": {
1717
"create_filter": "Create filter",
18-
"search_placeholder": "Search, \"word\" can specify searching",
18+
"search_placeholder": "Use \"quotation marks\" for exact search",
1919
"show_columns": "show columns",
2020
"modal": {
2121
"show_columns": "Show columns"

0 commit comments

Comments
 (0)