diff --git a/README.md b/README.md new file mode 100644 index 0000000..a97bba7 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# SimplePack-dotnet 🧳 + + +This is a dotnet binary encoding library intended to encode bytes messages suitable for transmission over text-only channels, e.g. certain document formats, instant messages, and web pages. + +* Custom human meaningful header/footer +* Built in checksum for error detection (not cryptographic) +* No new lines or odd characters (uses base58). This means less mangling by external services. + +## Install + +Available on nuget: https://www.nuget.org/packages/SimplePack-base58/ + + +## Usage + +``` +SimplePack packer = new SimplePack("MyHeader ", " MyFooter"); + +# encode +packer.encode(arbitraryBytes); +# decode +packer.decode("MyHeader MyFooter"); + +``` + diff --git a/SimplePack/SimplePack.cs b/SimplePack/SimplePack.cs index 8a4f937..29715e8 100644 --- a/SimplePack/SimplePack.cs +++ b/SimplePack/SimplePack.cs @@ -7,6 +7,7 @@ namespace simplepack { private string head; private string foot; + public SimplePack(string header, string footer){ // Specify human meaningful header/footer string head = header; diff --git a/SimplePack/SimplePack.csproj b/SimplePack/SimplePack.csproj index aa21527..8c498a3 100644 --- a/SimplePack/SimplePack.csproj +++ b/SimplePack/SimplePack.csproj @@ -2,10 +2,22 @@ netstandard2.0 + Kevin Froman + + SimplePack + 2020 + SimplePack-base58 + GPL-3.0-or-later + Simple binary encoding format with built in checksum designed to avoid mangling. + + - - + + + + +