Skip to content

Commit 666b280

Browse files
committed
Fix links to work on PyPI
1 parent 25b3f49 commit 666b280

1 file changed

Lines changed: 30 additions & 27 deletions

File tree

README.md

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# orjson
22

33
orjson is a fast, correct JSON library for Python. It
4-
[benchmarks](#performance) as the fastest Python library for JSON and is
5-
more correct than the standard json library or third-party libraries. It
6-
serializes [dataclass](#dataclass) and [datetime](#datetime) instances by
7-
default.
4+
[benchmarks](https://github.com/ijl/orjson#performance) as the fastest Python
5+
library for JSON and is more correct than the standard json library or
6+
third-party libraries. It serializes
7+
[dataclass](https://github.com/ijl/orjson#dataclass) and
8+
[datetime](https://github.com/ijl/orjson#datetime) instances.
89

910
Its serialization performance on fixtures of real data is 2.5x to 9.5x the
1011
nearest other library and 4x to 12x the standard library. Its deserialization
@@ -39,26 +40,28 @@ requiring glibc 2.18, released 2013, or later. orjson does not support PyPy.
3940
orjson is licensed under both the Apache 2.0 and MIT licenses. The
4041
repository and issue tracker is
4142
[github.com/ijl/orjson](https://github.com/ijl/orjson), and patches may be
42-
submitted there.
43-
44-
1. [Usage](#usage)
45-
1. [Install](#install)
46-
2. [Serialize](#serialize)
47-
1. [default](#default)
48-
2. [option](#option)
49-
3. [Deserialize](#deserialize)
50-
2. [Types](#types)
51-
1. [dataclass](#dataclass)
52-
2. [datetime](#datetime)
53-
3. [float](#float)
54-
4. [int](#int)
55-
5. [str](#str)
56-
3. [Testing](#testing)
57-
4. [Performance](#performance)
58-
1. [Latency](#latency)
59-
2. [Memory](#memory)
60-
3. [Reproducing](#reproducing)
61-
5. [License](#license)
43+
submitted there. There is a
44+
[CHANGELOG](https://github.com/ijl/orjson/blob/master/CHANGELOG.md)
45+
available in the repository.
46+
47+
1. [Usage](https://github.com/ijl/orjson#usage)
48+
1. [Install](https://github.com/ijl/orjson#install)
49+
2. [Serialize](https://github.com/ijl/orjson#serialize)
50+
1. [default](https://github.com/ijl/orjson#default)
51+
2. [option](https://github.com/ijl/orjson#option)
52+
3. [Deserialize](https://github.com/ijl/orjson#deserialize)
53+
2. [Types](https://github.com/ijl/orjson#types)
54+
1. [dataclass](https://github.com/ijl/orjson#dataclass)
55+
2. [datetime](https://github.com/ijl/orjson#datetime)
56+
3. [float](https://github.com/ijl/orjson#float)
57+
4. [int](https://github.com/ijl/orjson#int)
58+
5. [str](https://github.com/ijl/orjson#str)
59+
3. [Testing](https://github.com/ijl/orjson#testing)
60+
4. [Performance](https://github.com/ijl/orjson#performance)
61+
1. [Latency](https://github.com/ijl/orjson#latency)
62+
2. [Memory](https://github.com/ijl/orjson#memory)
63+
3. [Reproducing](https://github.com/ijl/orjson#reproducing)
64+
5. [License](https://github.com/ijl/orjson#license)
6265

6366
## Usage
6467

@@ -193,12 +196,12 @@ b'"1970-01-01T00:00:00"'
193196
##### OPT_SERIALIZE_DATACLASS
194197

195198
Serialize `dataclasses.dataclass` instances. For more, see
196-
[dataclass](#dataclass).
199+
[dataclass](https://github.com/ijl/orjson#dataclass).
197200

198201
##### OPT_STRICT_INTEGER
199202

200203
Enforce 53-bit limit on integers. The limit is otherwise 64 bits, the same as
201-
the Python standard library. For more, see [int](#int).
204+
the Python standard library. For more, see [int](https://github.com/ijl/orjson#int).
202205

203206
##### OPT_UTC_Z
204207

@@ -605,5 +608,5 @@ scripts. The memory results can be reproduced using the `pymem` script.
605608

606609
## License
607610

608-
orjson was written by ijl <ijl@mailbox.org>, copyright 2018 - 2020, licensed
611+
orjson was written by ijl <<ijl@mailbox.org>>, copyright 2018 - 2020, licensed
609612
under either the Apache 2 or MIT licenses.

0 commit comments

Comments
 (0)