Skip to content

Commit 8b24b75

Browse files
authored
Tweak readme
1 parent 78aadca commit 8b24b75

File tree

1 file changed

+10
-15
lines changed

1 file changed

+10
-15
lines changed

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,8 @@
2222

2323
## Introduction
2424

25-
This library provides an [RFC 6901](https://tools.ietf.org/html/rfc6901) compliant JSON pointer implementation
26-
to handle and manipulate arbitrary JSON values with type-safety.
27-
28-
## Installation
29-
30-
We recommend using [NPM](https://www.npmjs.com) to install the package:
31-
32-
```sh
33-
npm install @croct-tech/json-pointer
34-
```
35-
36-
## Overview
37-
38-
This library ships with a fast implementation of the JSON Pointer specification, as described in
39-
[RFC 6901](https://tools.ietf.org/html/rfc6901).
25+
This library provides a fast, [RFC 6901](https://tools.ietf.org/html/rfc6901) compliant JSON pointer implementation
26+
to manipulate arbitrary JSON values with type-safety.
4027

4128
These are the main highlight that distinguishes it from similar libraries:
4229

@@ -46,6 +33,14 @@ These are the main highlight that distinguishes it from similar libraries:
4633
- Restricts operations such that no array becomes sparse
4734
- Ensures that a valid `JsonStructure` modified by a `JsonPointer` results in a still valid `JsonStructure`
4835

36+
## Installation
37+
38+
We recommend using [NPM](https://www.npmjs.com) to install the package:
39+
40+
```sh
41+
npm install @croct-tech/json-pointer
42+
```
43+
4944
## Contributing
5045

5146
Contributions to the package are always welcome!

0 commit comments

Comments
 (0)