oliang 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +11 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,5 +1,8 @@
1
1
  # oliang
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/oliang.svg)](https://www.npmjs.com/package/oliang)
4
+ [![license](https://img.shields.io/npm/l/oliang.svg)](https://github.com/thefordz/oliang/blob/main/LICENSE)
5
+
3
6
  Tiny error-handling core for Express + TypeScript apps ☕
4
7
 
5
8
  > Looking to start a new project? Use the scaffolder instead:
@@ -7,6 +10,8 @@ Tiny error-handling core for Express + TypeScript apps ☕
7
10
  > ```bash
8
11
  > npm create oliang
9
12
  > ```
13
+ >
14
+ > See [`create-oliang`](https://www.npmjs.com/package/create-oliang).
10
15
 
11
16
  ## Install
12
17
 
@@ -41,3 +46,9 @@ app.use(errorHandler);
41
46
  - `errorHandler` — Express error middleware that maps `AppError` to JSON responses
42
47
  - `HTTPSTATUS` / `HttpStatusCodeType` — HTTP status constants
43
48
  - `getEnv` — env reader that throws at startup when a required variable is missing
49
+
50
+ ## Requirements
51
+
52
+ - Node.js >= 18
53
+ - Express >= 4 (peer dependency)
54
+ - TypeScript types included — no separate `@types` package needed
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "oliang",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Tiny error-handling core for Express + TypeScript apps. Scaffold a full app with `npm create oliang` ☕",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",