aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--lib/Hashing.Portable/README.md5
-rw-r--r--lib/Net.Http/readme.md6
-rw-r--r--lib/Net.Messaging.FBM/README.md5
-rw-r--r--lib/Net.Rest.Client/README.md5
-rw-r--r--lib/Net.Transport.SimpleTCP/README.md3
-rw-r--r--lib/Plugins.Essentials.ServiceStack/README.md3
-rw-r--r--lib/Plugins.Essentials/README.md5
-rw-r--r--lib/Plugins.Runtime/README.md3
-rw-r--r--lib/Plugins.Runtime/src/VNLib.Plugins.Runtime.csproj2
-rw-r--r--lib/Plugins/README.md3
-rw-r--r--lib/Utils/README.md2
-rw-r--r--lib/WinRpMalloc/README.md17
12 files changed, 52 insertions, 7 deletions
diff --git a/lib/Hashing.Portable/README.md b/lib/Hashing.Portable/README.md
index 5ebf6be..08a1f44 100644
--- a/lib/Hashing.Portable/README.md
+++ b/lib/Hashing.Portable/README.md
@@ -4,6 +4,9 @@
This library is a collection of common cryptographic functions, optimized using the VNLib.Utils
library for interop and memory management.
+#### Builds
+Debug build w/ symbols & xml docs, release builds, NuGet packages, and individually packaged source code are available on my [website](https://www.vaughnnugent.com/resources/software). All tar-gzip (.tgz) files will have an associated .sha384 appended checksum of the desired download file.
+
## Argon2
This library contains an native library interface with the Argon2 Cryptographic Hashing library. If you wish to use the Argon2 hashing functions, you must include the [Argon2 native library](https://github.com/P-H-C/phc-winner-argon2) in your project, and accept the license.
@@ -12,7 +15,7 @@ The Argon2 native libary is lazy loaded and therefor not required for the other
**Notice:**
This library does not, modify, contribute, or affect the functionality of the Argon2 library in any way.
-#### Usage:
+### Usage:
```
//Using the managed hash version, inputs may be binary or utf8 chars
string encodedHash = VnArgon2.Hash2id(<password>,<salt>,<secret>,...<argon params>)
diff --git a/lib/Net.Http/readme.md b/lib/Net.Http/readme.md
index e69de29..6692205 100644
--- a/lib/Net.Http/readme.md
+++ b/lib/Net.Http/readme.md
@@ -0,0 +1,6 @@
+# VNLib.Net.Http
+
+*Provides a resource efficient, high performance, single library HTTP(s) server, with extensable processors and transport providers.*
+
+#### Builds
+Debug build w/ symbols & xml docs, release builds, NuGet packages, and individually packaged source code are available on my [website](https://www.vaughnnugent.com/resources/software). All tar-gzip (.tgz) files will have an associated .sha384 appended checksum of the desired download file. \ No newline at end of file
diff --git a/lib/Net.Messaging.FBM/README.md b/lib/Net.Messaging.FBM/README.md
index aabed75..9d3cd7a 100644
--- a/lib/Net.Messaging.FBM/README.md
+++ b/lib/Net.Messaging.FBM/README.md
@@ -1,3 +1,6 @@
# VNLib.Net.Messaging.FBM
-High performance structured web-socket based asynchronous request/response messaging library for .NET. \ No newline at end of file
+High performance structured web-socket based asynchronous request/response messaging library for .NET.
+
+#### Builds
+Debug build w/ symbols & xml docs, release builds, NuGet packages, and individually packaged source code are available on my [website](https://www.vaughnnugent.com/resources/software). All tar-gzip (.tgz) files will have an associated .sha384 appended checksum of the desired download file. \ No newline at end of file
diff --git a/lib/Net.Rest.Client/README.md b/lib/Net.Rest.Client/README.md
index 199f6e5..132c590 100644
--- a/lib/Net.Rest.Client/README.md
+++ b/lib/Net.Rest.Client/README.md
@@ -1 +1,4 @@
-# VNLib.Net.Rest.Client \ No newline at end of file
+# VNLib.Net.Rest.Client
+
+#### Builds
+Debug build w/ symbols & xml docs, release builds, NuGet packages, and individually packaged source code are available on my [website](https://www.vaughnnugent.com/resources/software). All tar-gzip (.tgz) files will have an associated .sha384 appended checksum of the desired download file. \ No newline at end of file
diff --git a/lib/Net.Transport.SimpleTCP/README.md b/lib/Net.Transport.SimpleTCP/README.md
index 2db8775..e61e1ba 100644
--- a/lib/Net.Transport.SimpleTCP/README.md
+++ b/lib/Net.Transport.SimpleTCP/README.md
@@ -4,6 +4,9 @@ _A managed .NET simple, high performance - single process, low/no allocation, fu
This library was created for use with the VNLib.Net.Http library and subsequent stacked framework libraries, however it was designed to be useful as a standalone high-performance .NET tcp listener. This library relies on the managed .NET [System.IO.Pipelines](https://github.com/dotnet/docs/blob/main/docs/standard/io/pipelines.md) library, and the **VNLib.Utils** library.
+#### Builds
+Debug build w/ symbols & xml docs, release builds, NuGet packages, and individually packaged source code are available on my [website](https://www.vaughnnugent.com/resources/software). All tar-gzip (.tgz) files will have an associated .sha384 appended checksum of the desired download file.
+
##### SSL Support
The TcpServer manages ssl/tls using the SslStream class to make tls as transparent to the application as possible. The server manages authentication and negotiation based on the configured `SslServerAuthenticationOptions`
diff --git a/lib/Plugins.Essentials.ServiceStack/README.md b/lib/Plugins.Essentials.ServiceStack/README.md
index a477635..aa33435 100644
--- a/lib/Plugins.Essentials.ServiceStack/README.md
+++ b/lib/Plugins.Essentials.ServiceStack/README.md
@@ -2,6 +2,9 @@
This library contains all of the utilities required for an application to build VNLib.Net.Http.HttpServer listeners for nearly unlimited virtual hosts.
+#### Builds
+Debug build w/ symbols & xml docs, release builds, NuGet packages, and individually packaged source code are available on my [website](https://www.vaughnnugent.com/resources/software). All tar-gzip (.tgz) files will have an associated .sha384 appended checksum of the desired download file.
+
### Breakdown
**HttpServiceStack** - This immutable data structure represents a collection of listening HttpServer instances across the ServiceDomain, and manages the entire lifecycle of those servers.
diff --git a/lib/Plugins.Essentials/README.md b/lib/Plugins.Essentials/README.md
index 2399b61..a085c05 100644
--- a/lib/Plugins.Essentials/README.md
+++ b/lib/Plugins.Essentials/README.md
@@ -1,3 +1,6 @@
# VNLib.Plugins.Essentials
-A library to add essential http processing features to your VNLib http application. This library is a part of the VNLib project and mostly focuses on the http content processing. It provides a layer between the base HTTP protocol and serving web content. It provides essential processing layers, extension methods, helper namespaces and more. Some features include stateful sessions, dynamic content routing, runtime extensible plugins, and abstractions for building plugins. \ No newline at end of file
+A library to add essential http processing features to your VNLib http application. This library is a part of the VNLib project and mostly focuses on the http content processing. It provides a layer between the base HTTP protocol and serving web content. It provides essential processing layers, extension methods, helper namespaces and more. Some features include stateful sessions, dynamic content routing, runtime extensible plugins, and abstractions for building plugins.
+
+#### Builds
+Debug build w/ symbols & xml docs, release builds, NuGet packages, and individually packaged source code are available on my [website](https://www.vaughnnugent.com/resources/software). All tar-gzip (.tgz) files will have an associated .sha384 appended checksum of the desired download file. \ No newline at end of file
diff --git a/lib/Plugins.Runtime/README.md b/lib/Plugins.Runtime/README.md
index 1146c9b..98690bd 100644
--- a/lib/Plugins.Runtime/README.md
+++ b/lib/Plugins.Runtime/README.md
@@ -2,6 +2,9 @@
A library that manages the runtime loading/unloading of a managed .NET assembly that exposes one or more types that implement the VNLib.Plugins.IPlugin interface, and the plugins lifecycle. The `DynamicPluginLoader` class also handles "hot" assembly reload and exposes lifecycle hooks for applications to correctly detect those changes.
+#### Builds
+Debug build w/ symbols & xml docs, release builds, NuGet packages, and individually packaged source code are available on my [website](https://www.vaughnnugent.com/resources/software). All tar-gzip (.tgz) files will have an associated .sha384 appended checksum of the desired download file.
+
### 3rd Party Dependencies
This library does not, modify, contribute, or affect the functionality of any of the 3rd party libraries below.
diff --git a/lib/Plugins.Runtime/src/VNLib.Plugins.Runtime.csproj b/lib/Plugins.Runtime/src/VNLib.Plugins.Runtime.csproj
index 470aa05..fa57c9e 100644
--- a/lib/Plugins.Runtime/src/VNLib.Plugins.Runtime.csproj
+++ b/lib/Plugins.Runtime/src/VNLib.Plugins.Runtime.csproj
@@ -17,7 +17,6 @@ that export the VNLib.Plugin.IPlugin interface.</Description>
<AssemblyOriginatorKeyFile>\\vaughnnugent.com\Internal\Folder Redirection\vman\Documents\Programming\Software\StrongNameingKey.snk</AssemblyOriginatorKeyFile>
</PropertyGroup>
-
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<Deterministic>False</Deterministic>
</PropertyGroup>
@@ -25,7 +24,6 @@ that export the VNLib.Plugin.IPlugin interface.</Description>
<Deterministic>False</Deterministic>
</PropertyGroup>
-
<ItemGroup>
<PackageReference Include="ErrorProne.NET.CoreAnalyzers" Version="0.1.2">
<PrivateAssets>all</PrivateAssets>
diff --git a/lib/Plugins/README.md b/lib/Plugins/README.md
index c08107a..1f08b6f 100644
--- a/lib/Plugins/README.md
+++ b/lib/Plugins/README.md
@@ -4,6 +4,9 @@ A compact and simple contract interface and supporting types for runtime loadabl
**This library has no internal or external dependencies**
+#### Builds
+Debug build w/ symbols & xml docs, release builds, NuGet packages, and individually packaged source code are available on my [website](https://www.vaughnnugent.com/resources/software). All tar-gzip (.tgz) files will have an associated .sha384 appended checksum of the desired download file.
+
### Usage with VNLib.Plugins.Essentials.
The **VNLib.Plugins.Essentials** library discovers IEndpoint types at runtime inside `EventProcessor` types. For correct usage with the `EventProcessor` class you should implement the interface `IVirtualEndpoint<HttpEntity>` otherwise your endpoint will not get loaded.
diff --git a/lib/Utils/README.md b/lib/Utils/README.md
index ddd7e84..683cc3c 100644
--- a/lib/Utils/README.md
+++ b/lib/Utils/README.md
@@ -10,6 +10,8 @@ namespaces
- VNLib.Utils.Memory - Utilities for safely accessing unmanaged memory and CLR memory
- VNLib.Utils.Memory.Caching - Data structures for managed object, data caching, and interfaces for cache-able objects
+#### Builds
+Debug build w/ symbols & xml docs, release builds, NuGet packages, and individually packaged source code are available on my [website](https://www.vaughnnugent.com/resources/software). All tar-gzip (.tgz) files will have an associated .sha384 appended checksum of the desired download file.
### Recommended 3rd Party Libs
diff --git a/lib/WinRpMalloc/README.md b/lib/WinRpMalloc/README.md
index 4f72b66..29164cf 100644
--- a/lib/WinRpMalloc/README.md
+++ b/lib/WinRpMalloc/README.md
@@ -1 +1,16 @@
-# WinRpMalloc \ No newline at end of file
+# WinRpMalloc
+
+*A project to maintain a Windows dll for RpMalloc by Mattias Jansson with some basic defaults for .NET loading*
+
+#### Builds
+Debug build w/ symbols & xml docs, release builds, and individually packaged source code are available on my [website](https://www.vaughnnugent.com/resources/software). All tar-gzip (.tgz) files will have an associated .sha384 appended checksum of the desired download file.
+
+## RPMalloc
+
+[**RPMalloc**](https://github.com/mjansson/rpmalloc) By Mattias Jansson - A cross-platform, lock-free, efficient memory allocator.
+
+
+#### Notes
+This project exists to maintain a working clone of of the RpMalloc library specifically to produce a Windows 64-bit native library that exposes the api for use by runtimes such as Microsft .NET.
+
+You may wish to collect the source code and build the library yourself directly from Mattias's. \ No newline at end of file