Better illustrated the CST format in the README.

This commit is contained in:
Tony Bark 2020-12-11 02:14:05 -05:00
parent 1f1066e7b4
commit 1454754921

View file

@ -2,12 +2,16 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)
Caret-Separated Text (or CST) is a key-value pair format represented by numbers or words as keys and the value is the string enclosed between carets (^) that contains the contents. Any text which is not enclosed with carets is considered a comment and ignored. Neither strings nor comments may use the caret character. Caret-Separated Text (or CST) is a key-value pair format represented by numbers or words as keys and the value is the string enclosed between carets that contains the contents. (e.g. ``<key> ^<value>^``) Any text which is not enclosed with carets is considered a comment and ignored. Neither strings nor comments may use the caret character.
QuickFennec.CST is a library for parsing the CST format. QuickFennec.CST is a library for parsing the CST format.
## Usage ## Usage
```text
1 ^The quick brown fox jumps over the lazy dog.^
```
```csharp ```csharp
#r "nuget:CSTNet,1.0.1" #r "nuget:CSTNet,1.0.1"
using System; using System;