Allow referencing directly from source

Make types partial, include public visibility in compiled version, provide instructions for source-only linking via dotnet-file.

Fixes #1

Author: kzu

readme.md

@@ -76,6 +76,34 @@ app.Use(async (context, next) =>
 });
 ```
 
+# Installation
+
+This project can be used either as a regular nuget package:
+
+```
+<PackageReference Include="WebSocketChannel" Version="*" />
+```
+
+Or alternatively, referenced directly as a source-only dependency using [dotnet-file](https://www.nuget.org/packages/dotnet-file):
+
+```
+> dotnet file add https://github.com/devlooped/WebSocketChannel/blob/main/src/WebSocketChannel/WebSocketChannel.cs
+> dotnet file add https://github.com/devlooped/WebSocketChannel/blob/main/src/WebSocketChannel/WebSocketExtensions.cs
+```
+
+It's also possible to specify a desired target location for the referenced source files, such as:
+
+```
+> dotnet file add https://github.com/devlooped/WebSocketChannel/blob/main/src/WebSocketChannel/WebSocketChannel.cs src/MyProject/External/.
+> dotnet file add https://github.com/devlooped/WebSocketChannel/blob/main/src/WebSocketChannel/WebSocketExtensions.cs src/MyProject/External/.
+```
+
+When referenced as loose source files, it's easy to also get automated PRs when the upstream files change, 
+as in the [dotnet-file.yml](https://github.com/devlooped/dotnet-file/blob/main/.github/workflows/dotnet-file.yml) workflow that 
+keeps the repository up to date with a template. See also [dotnet-config](https://dotnetconfig.org), which is used to 
+for the `dotnet-file` configuration settings that tracks all this.
+
+
 
 # Dogfooding
 

src/WebSocketChannel/Visibility.cs

@@ -0,0 +1,9 @@
+namespace Devlooped.Net
+{
+    public static partial class WebSocketChannel { }
+}
+
+namespace System.Net.WebSockets
+{
+    public static partial class WebSocketExtensions { }
+}

src/WebSocketChannel/WebSocketChannel.cs

@@ -10,7 +10,7 @@ namespace Devlooped.Net;
 /// Due to the nature of the underlying <see cref="WebSocket"/>, no concurrent writing 
 /// or reading is allowed, so the returned channel is effectively thread-safe by design. 
 /// </remarks>
-public static class WebSocketChannel
+static partial class WebSocketChannel
 {
     /// <summary>
     /// Creates a channel over the given <paramref name="webSocket"/> for reading/writing 

src/WebSocketChannel/WebSocketExtensions.cs

@@ -9,7 +9,7 @@ namespace System.Net.WebSockets;
 /// API.
 /// </summary>
 [EditorBrowsable(EditorBrowsableState.Never)]
-public static class WebSocketExtensions
+static partial class WebSocketExtensions
 {
     /// <summary>
     /// Creates a channel over the given <paramref name="webSocket"/> for reading/writing 

src/WebSocketChannel/readme.md

@@ -72,6 +72,33 @@ app.Use(async (context, next) =>
 ```
 
 
+# Installation
+
+This project can be used either as a regular nuget package:
+
+```
+<PackageReference Include="WebSocketChannel" Version="*" />
+```
+
+Or alternatively, referenced directly as a source-only dependency using [dotnet-file](https://www.nuget.org/packages/dotnet-file):
+
+```
+> dotnet file add https://github.com/devlooped/WebSocketChannel/blob/main/src/WebSocketChannel/WebSocketChannel.cs
+> dotnet file add https://github.com/devlooped/WebSocketChannel/blob/main/src/WebSocketChannel/WebSocketExtensions.cs
+```
+
+It's also possible to specify a desired target location for the referenced source files, such as:
+
+```
+> dotnet file add https://github.com/devlooped/WebSocketChannel/blob/main/src/WebSocketChannel/WebSocketChannel.cs src/MyProject/External/.
+> dotnet file add https://github.com/devlooped/WebSocketChannel/blob/main/src/WebSocketChannel/WebSocketExtensions.cs src/MyProject/External/.
+```
+
+When referenced as loose source files, it's easy to also get automated PRs when the upstream files change, 
+as in the [dotnet-file.yml](https://github.com/devlooped/dotnet-file/blob/main/.github/workflows/dotnet-file.yml) workflow that 
+keeps the repository up to date with a template. See also [dotnet-config](https://dotnetconfig.org), which is used to 
+for the `dotnet-file` configuration settings that tracks all this.
+
 
 
 ## Sponsors