Improve documentations

carldebilly · Nov 24, 2024 · f6ffa89 · f6ffa89
1 parent 26a1b54
commit f6ffa89
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -3,9 +3,9 @@ This is a versatile http server designed to be used in mobile/UWP applications.
 
 Last build state (master): ![](https://carldebilly.visualstudio.com/_apis/public/build/definitions/66b77220-645e-4483-808e-0e5a63ea38ff/1/badge)
 
-| Package |  Build | Nuget |
-| -- | -- | -- |
-| Yllibed.HttpServer - stable | ![VSTS Build](https://carldebilly.visualstudio.com/_apis/public/build/definitions/66b77220-645e-4483-808e-0e5a63ea38ff/1/badge) | [![NuGet Status](http://img.shields.io/nuget/v/Yllibed.HttpServer.svg?style=flat)](https://www.nuget.org/packages/Yllibed.HttpServer/) |
+| Package | Build                                                                                                    | Nuget |
+| -- |----------------------------------------------------------------------------------------------------------| -- |
+| Yllibed.HttpServer - stable | ![Build Status](https://github.com/carldebilly/Yllibed.HttpServer/actions/workflows/build.yml/badge.svg) | [![NuGet Status](http://img.shields.io/nuget/v/Yllibed.HttpServer.svg?style=flat)](https://www.nuget.org/packages/Yllibed.HttpServer/) |
 
 ## Quick start-up
 

diff --git a/Yllibed.HttpServer.Json/README.md b/Yllibed.HttpServer.Json/README.md
@@ -0,0 +1,3 @@
+# Yllibed Http Server - JSON extension
+
+This is a simple extension to the Yllibed.HttpServer which allows to serve JSON content, using Newtonsoft's Json.NET library.
diff --git a/Yllibed.HttpServer.Json/Yllibed.HttpServer.Json.csproj b/Yllibed.HttpServer.Json/Yllibed.HttpServer.Json.csproj
@@ -4,10 +4,13 @@
 		<Description>Json adapter for Yllibed Versatile Http Server using Newtownsoft JSON.NET</Description>
 
 		<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+		<PackageReadmeFile>README.md</PackageReadmeFile>
 	</PropertyGroup>
 
 	<ItemGroup>
 		<ProjectReference Include="..\Yllibed.HttpServer\Yllibed.HttpServer.csproj" />
+
+		<None Include="README.md" Pack="true" PackagePath="/" />
 	</ItemGroup>
 
 	<ItemGroup>

diff --git a/Yllibed.HttpServer/README.md b/Yllibed.HttpServer/README.md
@@ -1 +1,18 @@
 # Yllibed Http Server
+
+This is a versatile http server designed to be used any applications which need to expose a simple web server.
+
+There is no dependencies on ASP.NET or other frameworks, it is self-contained.
+
+Common use cases are:
+* Return URL for OAuth2 authentication using external browser
+* Remote diagnostics/monitoring on your app
+* Building a headless Windows IoT app (for SSDP discovery or simply end-user configuration)
+* Any other use case where you need to expose a simple web server
+
+Limitations:
+* There is no support for HTTP 2.0+ (yet) or WebSockets
+* There is no support for HTTPS (TLS)
+* This HTTP server is not designed for performance or high capacity
+* It's perfect for small applications, or small need
+* 
diff --git a/Yllibed.HttpServer/Yllibed.HttpServer.csproj b/Yllibed.HttpServer/Yllibed.HttpServer.csproj
@@ -4,10 +4,16 @@
 		<Description>Yllibed Versatile Http Server</Description>
 
 		<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+		<PackageReadmeFile>README.md</PackageReadmeFile>
 	</PropertyGroup>
 
 	<ItemGroup>
 		<PackageReference Include="Microsoft.Extensions.Logging" Version="9.0.0" />
+
+		<None Include="README.md" Pack="true" PackagePath="/" />
+	</ItemGroup>
+
+	<ItemGroup Condition="'$(TargetFramework)'=='netstandard2.0'">
 		<PackageReference Include="System.Collections.Immutable" Version="9.0.0" />
 		<PackageReference Include="System.ValueTuple" Version="4.5.0" />
 	</ItemGroup>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Yllibed Http Server - JSON extension

		This is a simple extension to the Yllibed.HttpServer which allows to serve JSON content, using Newtonsoft's Json.NET library.