Skip to content

Commit 01ea34d

Browse files
committed
Add table of contents to README
1 parent f2e92f3 commit 01ea34d

1 file changed

Lines changed: 34 additions & 2 deletions

File tree

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,47 @@
77
width="200px" />
88
<!-- markdownlint-enable -->
99

10-
**[JSON][json-1]ID**entification tool and ruleset. JSONID can be downloaded
10+
[**JSONID**][json-1]entification tool and ruleset. JSONID can be downloaded
1111
from pypi.org.
1212

1313
[![PyPI - Version](https://img.shields.io/pypi/v/jsonid?style=plastic&color=purple)][pypi-json-id-1]
1414

1515
[json-1]: https://www.json.org/json-en.html
1616
[pypi-json-id-1]: https://pypi.org/project/jsonid/
1717

18-
## Function
18+
<!-- markdownlint-disable MD004 -->
19+
20+
## Contents
21+
22+
- [Introduction](#introduction)
23+
- [Why?](#why)
24+
- [What does JSONID get you?](#what-does-jsonid-get-you)
25+
- [Ruleset](#ruleset)
26+
- [Backed by testing](#backed-by-testing)
27+
- [Registry](#registry)
28+
- [Registry examples](#registry-examples)
29+
- [Local rules](#local-rules)
30+
- [PRONOM](#pronom)
31+
- [Output format](#output-format)
32+
- [Sample files](#sample-files)
33+
- [Integration files](#integration-files)
34+
- [Fundamental examples](#fundamental-examples)
35+
- [Analysis](#analysis)
36+
- [Example analysis](#example-analysis)
37+
- [Utils](#utils)
38+
- [json2json](#json2json)
39+
- [Docs](#docs)
40+
- [Developer install](#developer-install)
41+
- [pip](#pip)
42+
- [tox](#tox)
43+
- [pre-commit](#pre-commit)
44+
- [Packaging](#packaging)
45+
- [pyproject.toml](#pyprojecttoml)
46+
- [Versioning](#versioning)
47+
- [Local packaging](#local-packaging)
48+
- [Publishing](#publishing)
49+
50+
## Introduction
1951

2052
JSONID borrows from the Python approach to ask forgiveness rather than
2153
permission (EAFP) to attempt to open every object it scans and see if it

0 commit comments

Comments
 (0)