Skip to content

Commit 2ed22f8

Browse files
committed
Update README.md
organise content
1 parent a4ae4b2 commit 2ed22f8

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,12 @@
11
# renderlayer
22

3-
Light, Modern, Stable - 3D Rendering Layer for the Web
3+
WebGL 2 rendering library targeting modern browsers.
44

55
[![NPM version][npm-badge]][npm-url]
66
[![License][license-badge]][license-url]
77
[![CI][ci-badge]][ci-url]
88
[![Coverage][codecov-badge]][codecov-url]
99

10-
## Scripts
11-
12-
| Action | Command | Description |
13-
| ------------- | ----------------------- | ---------------------------------- |
14-
| build | `npm run build` | Build all modules |
15-
| meta | `npm run meta` | Create esbuild meta for analysis |
16-
| check | `npm run check` | Check for circular dependencies |
17-
| lint | `npm run lint` | Run static code analysis |
18-
| test | `npm run test` | Run unit tests and exit |
19-
| test-watch | `npm run test-watch` | Watch for changes and re-run tests |
20-
| test-coverage | `npm run test-coverage` | Generate a test coverage report |
21-
| format | `npm run format` | Check source file formatting |
22-
| format-fix | `npm run format-fix` | Format source files |
23-
2410
## Structure
2511

2612
This repository employs a [monorepo](https://en.wikipedia.org/wiki/Monorepo) setup which hosts a number of associated packages under the `packages` directory. They can be used in any combination and define minimum dependencies between each other.
@@ -58,6 +44,20 @@ A convenience package is provided to make core packages available to your develo
5844
| ------------- | ------------------------------------ | ----------- |
5945
| `renderlayer` | [![NPM version][npm-badge]][npm-url] | bundle |
6046

47+
## Scripts
48+
49+
| Action | Command | Description |
50+
| ------------- | ----------------------- | ---------------------------------- |
51+
| build | `npm run build` | Build all modules |
52+
| meta | `npm run meta` | Create esbuild meta for analysis |
53+
| check | `npm run check` | Check for circular dependencies |
54+
| lint | `npm run lint` | Run static code analysis |
55+
| test | `npm run test` | Run unit tests and exit |
56+
| test-watch | `npm run test-watch` | Watch for changes and re-run tests |
57+
| test-coverage | `npm run test-coverage` | Generate a test coverage report |
58+
| format | `npm run format` | Check source file formatting |
59+
| format-fix | `npm run format-fix` | Format source files |
60+
6161
## Tools
6262

6363
| Tool | Reference |

0 commit comments

Comments
 (0)