Skip to content

Commit 394cb7f

Browse files
committed
docs(README.md): improve and rephrase the text.
[skip ci]
1 parent 2d53575 commit 394cb7f

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,27 @@
55
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ru.mystamps%3Amystamps&metric=alert_status)](https://sonarcloud.io/dashboard?id=ru.mystamps%3Amystamps)
66
[![Uptime Statistic](https://badgen.net/uptime-robot/month/ur243278-551fbb732949dbdee27c7552)](https://stats.uptimerobot.com/1jXAjFpgP)
77

8-
## What's it?
8+
## What is it?
99

10-
It's a website for anybody who collects post stamps and wants to have an online version of the collection.
10+
This is a website for anybody who collects post stamps and wants to have an online version of the collection.
1111

1212
## How can it be useful to me?
1313

14-
With this site you can:
15-
* look at the statistic (including charts) about your collection (how many series and stamps do you have? From which countries and in which categories they are?)
14+
On the site you can:
15+
* see the statistics (including charts) about your collection: how many series and stamps do you have? From what countries and from what categories?
1616
* share a link to the collection with friends
17-
* use it as a list of stamps which you are selling on auction
18-
* add to the signature on forums
17+
* use it as a list of the stamps that you are selling on an auction
18+
* add to the signature on the forums or e-mail
1919
* use it where a photo of your collection is needed
2020

2121
## How can I try it?
2222

2323
You can look at it and try on https://my-stamps.ru
2424

2525
If you are programmer/sysadmin or you just feeling that you are able to run a local version of the site then follow the following instructions:
26+
If you want to run it locally, follow the instructions:
2627

27-
* install Java (at least 8th version is required)
28+
* install JDK (at least 8th version is required)
2829
* clone this project
2930
* from the console inside the directory with source code, execute the command `./mvnw spring-boot:run`
3031
* open up `http://127.0.0.1:8080` in a browser
@@ -33,7 +34,7 @@ If you are programmer/sysadmin or you just feeling that you are able to run a lo
3334

3435
**Caution!** The purpose of that version is a preview of the site and its capabilities. Because of that, the **changes** that you can make on the site **will be lost after stopping the server**!
3536

36-
## What's inside? (interesting only for programmers)
37+
## What is inside?
3738

3839
* *At the heart of*: Spring Framework (and especially Spring Boot)
3940
* *Template engine*: Thymeleaf

0 commit comments

Comments
 (0)