From afb61ac44ee99f433cf7dfaf18f2fc50757a1c5f Mon Sep 17 00:00:00 2001 From: Paul Miller Date: Sun, 8 Dec 2024 13:29:17 +0000 Subject: [PATCH] readme --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e219388..3d46cb1 100644 --- a/README.md +++ b/README.md @@ -577,14 +577,15 @@ gcm-256 (encrypt, 1MB) ## Contributing & testing -1. Clone the repository -2. `npm install` to install build dependencies like TypeScript -3. `npm run build` to compile TypeScript code -4. `npm run test` will execute all main tests +* `npm install && npm run build && npm test` will build the code and run tests. +* `npm run lint` / `npm run format` will run linter / fix linter issues. +* `npm run bench` will run benchmarks, which may need their deps first (`npm run bench:install`) +* `cd build && npm install && npm run build:release` will build single file -## Resources +Check out [github.com/paulmillr/guidelines](https://github.com/paulmillr/guidelines) +for general coding practices and rules. -Check out [paulmillr.com/noble](https://paulmillr.com/noble/) +See [paulmillr.com/noble](https://paulmillr.com/noble/) for useful resources, articles, documentation and demos related to the library.