Skip to content

Commit 3d29ec0

Browse files
Updated README with installation notes
1 parent e6d70d5 commit 3d29ec0

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
# Hyperjump - Better JSON Schema Errors
22
It transforms standard, machine-oriented validation output into clear, human-friendly error messages ideal for API responses and developer tools. Built upon the official JSON Schema Output Format introduced in draft 2019-09, it ensures seamless compatibility with any compliant validator.
33

4-
### Node.js
54

6-
```bash
7-
npm install @hyperjump/better-json-schema-errors
8-
```
5+
> **Note:** This package is not yet published to npm. You can clone this repository locally to experiment with it:
6+
> ```bash
7+
> git clone https://github.com/hyperjump-io/better-json-schema-errors.git
8+
> ```
9+
> ```bash
10+
> cd better-json-schema-errors
11+
> ```
12+
> ```bash
13+
> npm install
14+
> ```
15+
> This project is currently a **work in progress** and will be published to npm once completed.
16+
917
1018
## API Error Message Format
1119

0 commit comments

Comments
 (0)