added readme and package info

This commit is contained in:
Kevin Froman 2020-05-27 03:00:18 -05:00
parent 2ffdecbcf4
commit b4204eeb40
No known key found for this signature in database
GPG Key ID: BF1CE85F428B8CE3
3 changed files with 41 additions and 2 deletions

26
README.md Normal file
View File

@ -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 <encode result data> MyFooter");
```

View File

@ -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;

View File

@ -2,10 +2,22 @@
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<Authors>Kevin Froman</Authors>
<Company></Company>
<Title>SimplePack</Title>
<Copyright>2020</Copyright>
<PackageId>SimplePack-base58</PackageId>
<PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
<description>Simple binary encoding format with built in checksum designed to avoid mangling.</description>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Base58Check" Version="0.2.0" />
<ItemGroup>
<PackageReference Include="Base58Check" Version="0.2.0" />
<None Include="../LICENSE.txt" Pack="true" PackagePath="LICENSE.txt"/>
</ItemGroup>
</Project>