Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
organise content
  • Loading branch information
epreston committed Nov 27, 2023
1 parent a4ae4b2 commit 2ed22f8
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
# renderlayer

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

[![NPM version][npm-badge]][npm-url]
[![License][license-badge]][license-url]
[![CI][ci-badge]][ci-url]
[![Coverage][codecov-badge]][codecov-url]

## Scripts

| Action | Command | Description |
| ------------- | ----------------------- | ---------------------------------- |
| build | `npm run build` | Build all modules |
| meta | `npm run meta` | Create esbuild meta for analysis |
| check | `npm run check` | Check for circular dependencies |
| lint | `npm run lint` | Run static code analysis |
| test | `npm run test` | Run unit tests and exit |
| test-watch | `npm run test-watch` | Watch for changes and re-run tests |
| test-coverage | `npm run test-coverage` | Generate a test coverage report |
| format | `npm run format` | Check source file formatting |
| format-fix | `npm run format-fix` | Format source files |

## Structure

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.
Expand Down Expand Up @@ -58,6 +44,20 @@ A convenience package is provided to make core packages available to your develo
| ------------- | ------------------------------------ | ----------- |
| `renderlayer` | [![NPM version][npm-badge]][npm-url] | bundle |

## Scripts

| Action | Command | Description |
| ------------- | ----------------------- | ---------------------------------- |
| build | `npm run build` | Build all modules |
| meta | `npm run meta` | Create esbuild meta for analysis |
| check | `npm run check` | Check for circular dependencies |
| lint | `npm run lint` | Run static code analysis |
| test | `npm run test` | Run unit tests and exit |
| test-watch | `npm run test-watch` | Watch for changes and re-run tests |
| test-coverage | `npm run test-coverage` | Generate a test coverage report |
| format | `npm run format` | Check source file formatting |
| format-fix | `npm run format-fix` | Format source files |

## Tools

| Tool | Reference |
Expand Down

0 comments on commit 2ed22f8

Please sign in to comment.