Skip to content

Commit

Permalink
Updated main readme
Browse files Browse the repository at this point in the history
  • Loading branch information
burkmarr committed Dec 4, 2024
1 parent f02918b commit 5069570
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ This project is configured as a *Node* project. To install and run it in a local
### Documentation
The package uses JSDoc to produce the API documentation. JSDoc is not included in the package dependendies since developers normally install it globally in their development environment.

The library includes some creation methods for charts which are either, experimental, deprecated or undocumented. For an account of all of the chart creation methods and their status, see the [working examples](https://biologicalrecordscentre.github.io/brc-charts/docs/).

### Typical build & publish workflow
- `npm audit --omit=dev` (look for any important vulnerabilities)
- `npm run lint`
Expand Down

0 comments on commit 5069570

Please sign in to comment.