diff --git a/README.md b/README.md index 3997023..cc8b087 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ -# CSTNet +# QuickFennec.CST [![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. -CSTNet is a library for parsing the CST format. +QuickFennec.CST is a library for parsing the CST format. ## Usage ```csharp -#r "nuget:CSTNet,1.0.0" +#r "nuget:CSTNet,1.0.1" using System; using System.IO; -using CSTNet; +using QuickFennec.CST; var file = File.ReadAllText("example.cst"); var example = CaretSeparatedText.Parse(file, 1); @@ -22,10 +22,10 @@ Console.WriteLine(example); In production, CST files were used in The Sims Online to provide translations. Each translation was split into their respective directories: -- ``uitext/english.dir/hints/_154_miscstrings.cst`` -- ``uitext/swedish.dir/hints/_154_miscstrings.cst`` +- ``uitext/english.dir/misc/_154_miscstrings.cst`` +- ``uitext/swedish.dir/misc/_154_miscstrings.cst`` -CST.NET only provides the basic parsing functionality. +QuickFennec.CST only provides the basic parsing functionality. ## To-do @@ -33,7 +33,8 @@ CST.NET only provides the basic parsing functionality. ## Known issues -- Reading multiple lines +- Skipping comments is a little buggy. +- Multiline parsing with the v2 format is still unpredictable. ## Requirements ### Prerequisites