Skip to content

Commit 5913532

Browse files
committed
docs: minor documentation improvements
1 parent 9a0e3dd commit 5913532

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

NEWS.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
- (ci) cancel code coverage publishing to codecov.io service
4848

4949
0.4
50-
- (infrastructure) switched to Java8
50+
- (infrastructure) switched to Java 8
5151
- (user interface) ported to Bootstrap 3
5252
- (infrastructure) ported to Spring Boot
5353
- (functionality) implemented possibility to user to add additional images to series

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ This is a website for anybody who collects post stamps and wants to have an onli
1212
## How can it be useful to me?
1313

1414
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?
15+
* see the statistics (including charts) about your collection
16+
* number of series and stamps
17+
* from what countries
18+
* in what categories
19+
* amount of money that has been spent to buy the stamps
1620
* share a link to the collection with friends
1721
* use it as a list of the stamps that you are selling on an auction
1822
* add to the signature on the forums or e-mail
@@ -22,8 +26,7 @@ On the site you can:
2226

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

25-
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:
29+
If you are programmer/sysadmin, or you are just feeling that you are able to run a local version of the site, then follow the instructions:
2730

2831
* install JDK (8th version is required) and Maven
2932
* the preferred way to set up tools is to use [`mise`](https://mise.jdx.dev/getting-started.html). After its activation, the required tools will be installed automatically
@@ -49,4 +52,4 @@ If you want to run it locally, follow the instructions:
4952
* *Unit tests*: Groovy with Spock Framework or JUnit (for Java code), Jest (for JavaScript code)
5053
* *Integration tests*: Selenium3, RobotFramework, WireMock
5154
* *Deployment*: bash, Ansible, Terraform
52-
* *Others*: Lombok, Togglz, WebJars, AssertJ
55+
* *Others*: Lombok, Togglz, WebJars, AssertJ, Mockito

infra/terraform/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
```console
1212
$ cd infra/terraform
1313
```
14-
* Setup credentials (only first time)
14+
* Setup credentials (only the first time)
1515
```console
1616
$ cp terraform.tfvars{.example,}
1717
$ vim terraform.tfvars

0 commit comments

Comments
 (0)