Skip to content
This repository was archived by the owner on Apr 11, 2025. It is now read-only.

Commit 7889e81

Browse files
authored
docs: add table of contents
1 parent 38513de commit 7889e81

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@
44

55
A JavaScript package to disassemble then transform XML files into smaller JSON files. This is an extension of my [XML Disassembler](https://github.com/mcarvin8/xml-disassembler) package.
66

7+
<!-- TABLE OF CONTENTS -->
8+
<details>
9+
<summary>Table of Contents</summary>
10+
11+
- [Background](#background)
12+
- [Install](#install)
13+
- [Usage](#usage)
14+
- [XML2JSON](#xml2json)
15+
- [JSON2XML](#json2xml)
16+
- [Ignore File](#ignore-file)
17+
- [Logging](#logging)
18+
- [Template](#template)
19+
</details>
20+
721
## Background
822

923
Large XML files can be a pain to mantain in version control. These files can contain thousands of lines and it becomes very difficult to track changes made to these files in a standard version control server like GitHub.
@@ -26,7 +40,7 @@ npm install xml2json-disassembler
2640

2741
## Usage
2842

29-
### XML 2 JSON
43+
### XML2JSON
3044

3145
```typescript
3246
/*
@@ -119,7 +133,7 @@ will be disassembled into a sub-directory named `HR_Admin` as such:
119133

120134
<br>
121135

122-
### JSON 2 XML
136+
### JSON2XML
123137

124138
```typescript
125139
/*

0 commit comments

Comments
 (0)