Skip to content

Commit 825022e

Browse files
committed
readme
1 parent cf9d612 commit 825022e

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
# strfy-js
22

3+
## Stringify JSON as JavaScript 🌴
4+
35
<p align="center" width="100%">
46
<a href="https://github.com/pyramation/strfy-js/actions/workflows/run-tests.yaml">
57
<img height="20" src="https://github.com/pyramation/strfy-js/actions/workflows/run-tests.yaml/badge.svg" />
68
</a>
79
<a href="https://github.com/pyramation/strfy-js/blob/main/LICENSE-MIT"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
810
</p>
911

10-
`strfy-js` is a custom JavaScript serialization library that extends the capabilities of JSON serialization. This library allows property names to be unquoted if they comply with JavaScript naming conventions and provides flexible quoting options for string values, including handling special characters with alternative quotes or escaping.
12+
`strfy-js` is a custom JavaScript serialization library designed to extend the capabilities of JSON serialization. This library is particularly useful for generating JavaScript objects directly from JSON, enabling developers to work with JSON data more effectively within JavaScript environments.
1113

1214
## Features
1315

14-
- **Custom Property Naming:** Serialize JavaScript object keys without quotes if they are valid JavaScript identifiers.
15-
- **Flexible String Quoting:** Choose between single, double, or backtick quotes for string values depending on the content to avoid escaping.
16-
- **Pretty Printing:** Control the indentation of the output for better readability.
17-
- **Custom Replacers:** Similar to `JSON.stringify`, a replacer function can be used to filter or alter the values before they are serialized.
16+
### Features
17+
18+
- **🛠️ Extended Serialization**: Converts JSON to JavaScript objects, supporting output, such as properties without quotes, not typically handled by standard JSON.
19+
20+
- **⚙️ Customizable**: Offers various options to customize the output, making it suitable for different use cases. Tailor the serialization process to meet your specific requirements.
21+
22+
- **⚡ Lightweight and Fast**: Optimized for performance, making it a practical choice for applications that require fast serialization of large amounts of data. Ideal for handling high-load environments efficiently.
1823

1924
## Installation
2025

0 commit comments

Comments
 (0)