From db1c5484808b1100224c258a40d1b07057f1d054 Mon Sep 17 00:00:00 2001 From: Amit K Gupta Date: Sun, 16 Jun 2024 17:02:09 +0530 Subject: [PATCH] redesign README.md --- README.md | 104 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 62 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 500e1f36..342380df 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,32 @@ # [fast-xml-parser](https://www.npmjs.com/package/fast-xml-parser) -[![Known Vulnerabilities](https://snyk.io/test/github/naturalintelligence/fast-xml-parser/badge.svg)](https://snyk.io/test/github/naturalintelligence/fast-xml-parser) [![NPM quality][quality-image]][quality-url] [![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) [Try me](https://naturalintelligence.github.io/fast-xml-parser/) [![NPM total downloads](https://img.shields.io/npm/dt/fast-xml-parser.svg)](https://npm.im/fast-xml-parser) -[quality-image]: http://npm.packagequality.com/shield/fast-xml-parser.svg?style=flat-square -[quality-url]: http://packagequality.com/#?package=fast-xml-parser - Validate XML, Parse XML to JS Object, or Build XML from JS Object without C/C++ based libraries and no callback. -> XML Parser v5 is added for experimental use -> https://solothought.com +--- + +ads-thePowerGlassesBook +I had recently published a book, The Power Glasses. Please have a look. Your feedback would be helpful. You can [mail](githubissues@proton.me) me for a free copy. +
+ +Sponsor this project -Sponsor this project 👉 - + - + - Stubmatic donate button - + Stubmatic donate button +
+
+
+ +![fxp_sponsors](https://github.com/NaturalIntelligence/fast-xml-parser/assets/7692328/c9367497-d67e-410a-90a6-66e3808be929) ## Users @@ -63,14 +68,15 @@ Through OpenCollective + + + + +[more](./USERs.md) -Check the bigger [list](./USERs.md) - -The list of users is collected either from the list published by Github, communicated directly through mails/chat , or from other resources. If you feel that your name in the above list is incorrectly published or you're not the user of this library anymore then you can inform us to remove it. We'll do the necessary changes ASAP. +The list of users are mostly published by Github or communicated directly. Feel free to contact if you find any information wrong. -If you want to be an anonymous user of this application and don't want to be highlighted anywhere then you can contact me at -- githubissues@proton.me -- https://linkedin.com/in/amitguptagwl/ +--- ## Main Features @@ -79,7 +85,7 @@ If you want to be an anonymous user of this application and don't want to be hig * Validate XML data syntactically * Parse XML to JS Object * Build XML from JS Object -* Works with node packages, in browser, and in CLI (press try me button above for demo) +* Compatible to node js packages, in browser, and in CLI (click try me button above for demo) * Faster than any other pure JS implementation. * It can handle big files (tested up to 100mb). * Controlled parsing using various options @@ -137,48 +143,62 @@ In a HTML page ``` -Check lib folder for different browser bundles +Bundle size | Bundle Name | Size | | ------------------ | ---- | -| fxbuilder.min.js | 5.2K | -| fxparser.js | 50K | -| fxparser.min.js | 17K | -| fxp.min.js | 22K | +| fxbuilder.min.js | 6.5K | +| fxparser.min.js | 20K | +| fxp.min.js | 26K | | fxvalidator.min.js | 5.7K | ### Documents -**v3** -* [documents](./docs/v3/docs.md) - -**v4** -1. [GettingStarted.md](./docs/v4/1.GettingStarted.md) -2. [XML Parser](./docs/v4/2.XMLparseOptions.md) -3. [XML Builder](./docs/v4/3.XMLBuilder.md) -4. [XML Validator](./docs/v4/4.XMLValidator.md) -5. [Entities](./docs/v4/5.Entities.md) -6. [HTML Document Parsing](./docs/v4/6.HTMLParsing.md) -7. [PI Tag processing](./docs/v4/7.PITags.md) + + + + + + + +
v3v4v5
+ documents +
    +
  1. Getting Started
    2. +
  2. XML Parser
    3. +
  3. XML Builder
    4. +
  4. XML Validator
    5. +
  5. Entities
    6. +
  6. HTML Document Parsing
    7. +
  7. PI Tag processing
    8. +
    +
  1. Getting Started +
  2. Features
    3. +
  3. Options
    4. +
  4. Output Builders
    5. +
  5. Value Parsers
    6. +
+ +**note**: version 5 is released with version 4 tfor experimental use. Based on it's demand, it'll be developed and the features can be different in final release. + ## Performance +negative means error ### XML Parser -![](./docs/imgs/XMLParser_v4.png) + + + * Y-axis: requests per second * X-axis: File size -**Large files** -![](./docs/imgs/XMLParser_large_v4.png) -* Y-axis: requests per second -* X-axis: File size ### XML Builder -![](./docs/imgs/XMLBuilder_v4.png) + * Y-axis: requests per second -negative means error -[![](static/img/ni_ads_ads.gif)](https://github.com/NaturalIntelligence/ads/) + + ## Supporters