update readme + scripts

Author: yleflour

README.md

@@ -1,7 +1,28 @@
 # Node TS Starter
 
-> A modern Node TS starter project
+> A modern Node TS starter project using as many native Node.js features as possible
 
-## Warnings
+## Features
 
+- Modern TS config
+- Type stripping to run .ts files directly
+- Native Node.js test runner
+- Uses Yarn through corepack
+- Non intrusive ESLint config
+- Prettier config
+- Full VSCode config
+
+## Scripts
+
+- `yarn test` - Run all tests
+- `yarn test:types` - Run type checking
+- `yarn test:lint` - Run linting
+- `yarn test:unit` - Run unit tests
+- `yarn test:e2e` - Run E2E tests
+
+## Notes
+
+- Requires Node.js >= 22.9.0
+- Unit tests are suffixed with `.test.ts`
+- E2E tests are suffixed with `.e2e.ts`
 - If you want to use npm publish, make sure to set `"private": false` in your package.json

package.json

@@ -27,7 +27,8 @@
     "test:unit": "node --experimental-strip-types --experimental-test-snapshots --no-warnings --test src/**/*.test.ts",
     "test:e2e": "node --experimental-strip-types --experimental-test-snapshots --no-warnings --test src/**/*.e2e.ts",
     "test:lint": "yarn eslint . --cache",
-    "test:types": "tsc --noEmit"
+    "test:types": "tsc --noEmit",
+    "test": "yarn test:types && yarn test:lint && yarn test:unit && yarn test:e2e"
   },
   "devDependencies": {
     "@eslint/js": "^9.16.0",