From 14547549218918936e9e43cad79a682194f865c8 Mon Sep 17 00:00:00 2001 From: Tony Bark Date: Fri, 11 Dec 2020 02:14:05 -0500 Subject: [PATCH] Better illustrated the CST format in the README. --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7c8cb71..f54987a 100644 --- a/README.md +++ b/README.md @@ -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) -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. `` ^^``) 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. ## Usage +```text +1 ^The quick brown fox jumps over the lazy dog.^ +``` + ```csharp #r "nuget:CSTNet,1.0.1" using System;