Skip to content

Commit 1d39239

Browse files
committed
Update README
1 parent 7351cdf commit 1d39239

File tree

2 files changed

+30
-45
lines changed

2 files changed

+30
-45
lines changed

README.md

Lines changed: 30 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,29 @@
11
# [fast-xml-parser](https://www.npmjs.com/package/fast-xml-parser)
2-
[![NPM quality][quality-image]][quality-url]
3-
[![Coverage Status](https://coveralls.io/repos/github/NaturalIntelligence/fast-xml-parser/badge.svg?branch=master)](https://coveralls.io/github/NaturalIntelligence/fast-xml-parser?branch=master)
4-
[<img src="https://img.shields.io/badge/Try-me-blue.svg?colorA=FFA500&colorB=0000FF" alt="Try me"/>](https://naturalintelligence.github.io/fast-xml-parser/)
5-
[![NPM total downloads](https://img.shields.io/npm/dt/fast-xml-parser.svg)](https://npm.im/fast-xml-parser)
62

3+
[![NPM total downloads](https://img.shields.io/npm/dt/fast-xml-parser.svg)](https://npm.im/fast-xml-parser)
74

85
Validate XML, Parse XML to JS Object, or Build XML from JS Object without C/C++ based libraries and no callback.
96

7+
<img align="right" src="static/img/fxp_logo.png" width="180px" alt="FXP logo"/>
8+
9+
* Validate XML data syntactically. Use [detailed-xml-validator](https://github.com/NaturalIntelligence/detailed-xml-validator/) to verify business rules.
10+
* Parse XML to JS Objectand vice versa
11+
* Common JS, ESM, and browser compatible
12+
* Faster than any other pure JS implementation.
13+
14+
It can handle big files (tested up to 100mb). XML Entities, HTML entities, and DOCTYPE entites are supported. Unpaired tags (Eg `<br>` in HTML), stop nodes (Eg `<script>` in HTML) are supported. It can also preserve Order of tags in JS object
15+
1016
---
17+
# Your Support, Our Motivation
1118

12-
<small>Checkout our new library [Text2Chart](https://solothought.com/text2chart/flow) that constructs flow chart out of simple text. Very helpful in creating or alayzing an algorithm, and documentation purpose</small>
13-
<br>
19+
## Try out our New Thoughts
20+
21+
We've recently launched **Flowgger**
22+
<a href="https://github.com/solothought/flowgger"> <img src="static/img/flowgger_h.webp" alt="Flowgger Logging Framework" /></a>
23+
24+
Don't forget to check our new library [Text2Chart](https://solothought.com/text2chart/flow) that constructs flow chart out of simple text. Very helpful in creating or alayzing an algorithm, and documentation purpose.
25+
26+
## Financial Support
1427

1528
Sponsor this project
1629

@@ -50,9 +63,9 @@ Through OpenCollective
5063
-->
5164

5265
![fxp_sponsors](https://raw.githubusercontent.com/NaturalIntelligence/ThankYouBackers/main/assets/NI_sponsors.jpg)
53-
- <a href="https://github.com/cocopon" target="_blank">Hiroki Kokubun</a>
5466

5567
> This is a donation. No goods or services are expected in return. Any requests for refunds for those purposes will be rejected.
68+
5669
## Users
5770

5871
<a href="https://github.com/renovatebot/renovate" title="renovate" ><img src="https://avatars1.githubusercontent.com/u/38656520" width="60px" ></a>
@@ -79,30 +92,7 @@ Through OpenCollective
7992

8093
---
8194

82-
## Main Features
83-
84-
<img align="right" src="static/img/fxp_logo.png" width="180px" alt="FXP logo"/>
85-
86-
* Validate XML data syntactically
87-
* Parse XML to JS Object
88-
* Build XML from JS Object
89-
* Compatible to node js packages, in browser, and in CLI (click try me button above for demo)
90-
* Faster than any other pure JS implementation.
91-
* It can handle big files (tested up to 100mb).
92-
* Controlled parsing using various options
93-
* XML Entities, HTML entities, and DOCTYPE entites are supported.
94-
* unpaired tags (Eg `<br>` in HTML), stop nodes (Eg `<script>` in HTML) are supported.
95-
* You can restore almost same XML from JSON
96-
* Supports comments
97-
* It can preserve Order of tags in JS object
98-
* You can control if a single tag should be parsed into array.
99-
* Supports parsing of PI (Processing Instruction) tags with XML declaration tags
100-
* And many more other features.
101-
102-
## v6
103-
I developed v6 in Apr 2023. And I didn't get the chance to complete all the features. I've ensured that new features don't impact performance. With v6, you have more control on parsing output. Check [docs](./docs/v6) for syntax help and basic understanding.
104-
105-
Please leave a comment in discussion forum for your suggestions and if you really need v6.
95+
# More about this library
10696

10797
## How to use
10898

@@ -153,7 +143,7 @@ Bundle size
153143
| fxp.min.js | 26K |
154144
| fxvalidator.min.js | 5.7K |
155145

156-
### Documents
146+
## Documents
157147
<table>
158148
<tr><td>v3</td><td>v4 and v5</td><td>v6</td></tr>
159149
<tr>
@@ -179,8 +169,9 @@ Bundle size
179169
</tr>
180170
</table>
181171

182-
**note**: version 6 is released with version 4 for experimental use. Based on it's demand, it'll be developed and the features can be different in final release.
183-
Version 5 has the same functionalities as version 4.
172+
**note**:
173+
- Version 6 is released with version 4 for experimental use. Based on it's demand, it'll be developed and the features can be different in final release.
174+
- Version 5 has the same functionalities as version 4.
184175

185176
## Performance
186177
<small>negative means error</small>
@@ -198,10 +189,9 @@ Version 5 has the same functionalities as version 4.
198189
<img src="./docs/imgs/XMLBuilder_v4.png" width="50%" />
199190
* Y-axis: requests per second
200191

201-
202-
203192
<!-- [![](static/img/ni_ads_ads.gif)](https://github.com/NaturalIntelligence/ads/) -->
204193

194+
---
205195

206196
## Usage Trend
207197

@@ -211,20 +201,15 @@ Version 5 has the same functionalities as version 4.
211201
<img src="https://npm-compare.com/img/npm-trend/THREE_YEARS/fast-xml-parser.png" width="50%" alt="NPM Usage Trend of fast-xml-parser" />
212202
</a>
213203

214-
## Supporters
215-
### Contributors
204+
# Supporters
205+
#### Contributors
216206

217207
This project exists thanks to [all](graphs/contributors) the people who contribute. [[Contribute](docs/CONTRIBUTING.md)].
218-
<!-- <a href="graphs/contributors"><img src="https://opencollective.com/fast-xml-parser/contributors.svg?width=890&button=false" /></a> -->
219-
<!--
220-
### Lead Maintainers
221-
![Amit Gupta](https://avatars1.githubusercontent.com/u/7692328?s=100&v=4)
222-
[![Vohmyanin Sergey Vasilevich](https://avatars3.githubusercontent.com/u/783335?s=100&v=4)](https://github.com/Delagen)
223208

224-
### All Contributors -->
225209
<a href="graphs/contributors"><img src="https://opencollective.com/fast-xml-parser/contributors.svg?width=890&button=false" /></a>
226210

227-
### Backers
211+
212+
#### Backers from Open collective
228213

229214
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/fast-xml-parser#backer)]
230215

static/img/flowgger_h.webp

66.5 KB
Binary file not shown.

0 commit comments

Comments
 (0)