Skip to content

Commit 5af9eed

Browse files
authored
Update README.md
1 parent f851f5f commit 5af9eed

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,22 @@
77
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=hexlet-boilerplates_nodejs-package&metric=coverage)](https://sonarcloud.io/summary/new_code?id=hexlet-boilerplates_nodejs-package)
88
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=hexlet-boilerplates_nodejs-package&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=hexlet-boilerplates_nodejs-package)
99

10+
## Requirements
11+
12+
* Unix system (Macos/Linux)
13+
* Nodejs 22.x+
14+
* Make
15+
16+
## Description
17+
18+
Boilerplate for javascript projects with:
19+
20+
* Javascript (nodejs)
21+
* Eslint
22+
* Jest
23+
24+
For Typescript boilerplate see [typescript-package](https://github.com/hexlet-boilerplates/typescript-package)
25+
1026
## Setup
1127

1228
```bash
@@ -19,13 +35,15 @@ make install
1935
make test
2036
```
2137

38+
See other commands in [Makefile](./Makefile)
39+
2240
## Run tests with coverage
2341

2442
See [sonar-project.properties](./sonar-project.properties#1:2):
2543

2644
```bash
2745
make test-coverage
28-
# see ./coverage dir
46+
# see ./coverage
2947
```
3048

3149
---

0 commit comments

Comments
 (0)