Update docs

Author: Thorium

README.md

@@ -2,10 +2,10 @@
 # Owin.Compression
 
 Compression (Deflate / GZip) module for Microsoft OWIN Selfhost filesystem pipeline.
-Can be used also with AspNetCore e.g. with .NET8.0 and Kestrel.
+It can also be used with AspNetCore, e.g. with .NET8.0 and Kestrel.
 
-With this module you can compress, deflate / gzip large files (like concatenated *.js or *.css files) to reduce amount of web traffic.
-Supports eTag caching: If client sent hashcode match, sends 302 instead of re-sending the same content.
+With this module, you can compress (deflate or gzip) large files (like concatenated *.js or *.css files) to reduce the amount of web traffic.
+It supports eTag caching: If the client's sent hashcode is a match, send 302 instead of re-sending the same content.
 
 This project works on C# and F# and should work on all .NET platforms, also on Windows, and even Mono as well.
 

docs/content/index.fsx

@@ -14,7 +14,7 @@
 Owin.Compression
 ======================
 
-Owin.Compression (Deflate / GZip) module ("middleware") for Microsoft OWIN pipeline. Can be used with .NET Full, .NET Core, .NET Standard, .NET6.0, and so on. Works with Selfhost and AspNetCore (e.g. with Kestrel, which is OWIN based server).
+Owin.Compression (Deflate / GZip) module ("middleware") for the Microsoft OWIN pipeline. It can be used with .NET Full, .NET Core, .NET Standard, .NET6.0, and so on. It also works with Selfhost and AspNetCore (e.g. with Kestrel, which is OWIN based server).
 It compresses the web request responses to make the transfer smaller, and it supports eTag caching.
 
 <div class="row">
@@ -28,14 +28,14 @@ It compresses the web request responses to make the transfer smaller, and it sup
   <div class="span1"></div>
 </div>
 
-Default compression used is deflate, then gzip, as deflate should be faster.
+The default compression used is deflate, then gzip, as deflate should be faster.
 
 eTag-caching
 ----------
 
 1. When the server reads the content before compression, it calculates a hash-code over it.
 2. The hash-code is sent as ETag response header to the client with the response
-3. The next time the client asks the same resource, it sends an If-None-Match header in the request with the same value.
+3. The next time the client asks for the same resource, it sends an If-None-Match header in the request with the same value.
 4. After the server reads the content before the compression, it calculates a hash-code over it. If it matches the If-None-Match of the request, the server can skip the compression and skip the sending and just send http status code 304 to the client which means "use what you have, it's not modified since".
 
 
@@ -79,7 +79,7 @@ And now your files are smaller than with e.g. just Microsoft.Owin.StaticFiles -l
 
 <img src="https://raw.githubusercontent.com/Thorium/Owin.Compression/master/screen.png" alt="compressed" width="1000"/>
 
-Even though the browser sees everything as plain text, the traffic is actually transfered as compressed format.
+Even though the browser sees everything as plain text, the traffic is actually transferred in compressed format.
 You can monitor the traffic with e.g. Fiddler.
 
 Example #2
@@ -164,7 +164,7 @@ Example #4
 ----------
 
 Running on ASP.NET Core web API on .NET 6.0. You can use C# but this example is in F#
-just because shorter syntax. The full project is available at tests-folder of this project:
+just because of the shorter syntax. The full project is available in tests-folder of this project:
 
 *)
 
@@ -200,7 +200,7 @@ https://github.com/Thorium/Owin.Compression/tree/master/tests/Aspnet.Core.WebAPI
 Example #5
 ----------
 
-More complete example can be found <a href="/Thorium/WebsitePlayground">here</a>.
+More complete examples can be found <a href="/Thorium/WebsitePlayground">here</a>.
 
 
 Samples & documentation
@@ -221,10 +221,10 @@ Contributing and copyright
 
 The project is hosted on [GitHub][gh] where you can [report issues][issues], fork 
 the project and submit pull requests. If you're adding a new public API, please also 
-consider adding [samples][content] that can be turned into a documentation. You might
+consider adding [samples][content] that can be turned into documentation. You might
 also want to read the [library design notes][readme] to understand how it works.
 
-The library is available under Public Domain license, which allows modification and 
+The library is available under a Public Domain license, which allows modification and 
 redistribution for both commercial and non-commercial purposes. For more information see the 
 [License file][license] in the GitHub repository. 
 

docs/content/tutorial.fsx

@@ -11,7 +11,7 @@
 (**
 # Using this library (C-Sharp) #
 
-Create new C# console application project (.NET 4.5 or more). Add reference to NuGet-packages:
+Create a new C# console application project (.NET 4.5 or more). Add reference to NuGet-packages:
 
 - Microsoft.Owin
 - Microsoft.Owin.Hosting
@@ -89,7 +89,7 @@ do()
 Microsoft.Owin.Hosting.WebApp.Start<MyWebStartup> "http://*:8080"
 
 (**
-Or you can use app.UseCompressionModule() in the beginning of the configuration to compress the whole response.
+You can also use app.UseCompressionModule() at the beginning of the configuration to compress the whole response.
 *)
 
 type MyWebStartupExample2() =
@@ -100,4 +100,4 @@ type MyWebStartupExample2() =
         //app.UseFileServer(fileServerOptions) |> ignore
         //etc...
 
-        ()
+        ()

src/Owin.Compression.Standard/CompressionModule.fs

@@ -510,8 +510,8 @@ type CompressionExtensions =
     static member UseCompressionModule(app:IApplicationBuilder) =
         CompressionExtensions.UseCompressionModule(app, DefaultCompressionSettings)
 
-    /// You can set a path that is url that will be captured.
-    /// The subsequent url-path will be mapped to server path.
+    /// You can set a path, which is the URL that will be captured.
+    /// The subsequent url-path will be mapped to the server path.
     [<Extension>]
     static member MapCompressionModule(app:IApplicationBuilder, path:PathString, settings:CompressionSettings) =
         app.Map(path, fun ap ->
@@ -532,8 +532,8 @@ type CompressionExtensions =
             } :> Task
         )
 
-    /// You can set a path that is url that will be captured.
-    /// The subsequent url-path will be mapped to server path.
+    /// You can set a path, which is the URL that will be captured.
+    /// The subsequent url-path will be mapped to the server path.
     /// Uses OwinCompression.DefaultCompressionSettings
     [<Extension>]
     static member MapCompressionModule(app:IApplicationBuilder, path:PathString) =

src/Owin.Compression/CompressionModule.fs

@@ -15,7 +15,7 @@ type SupportedEncodings =
 | Deflate
 | GZip
 
-/// Do you fetch files or do you encode context.Response.Body?
+/// Do you fetch files, or do you encode context.Response.Body?
 type ResponseMode =
 | File
 | ContextResponseBody of Next: Func<Task>
@@ -458,17 +458,17 @@ type CompressionExtensions =
     static member UseCompressionModule(app:IAppBuilder) =
         CompressionExtensions.UseCompressionModule(app, DefaultCompressionSettings)
 
-    /// You can set a path that is url that will be captured.
-    /// The subsequent url-path will be mapped to server path.
+    /// You can set a path, which is the URL that will be captured.
+    /// The subsequent url-path will be mapped to the server path.
     [<Extension>]
     static member MapCompressionModule(app:IAppBuilder, path:string, settings:CompressionSettings) =
         app.Map(path, fun ap ->
          ap.Run(fun context ->
             (Internals.compress context settings ResponseMode.File)() 
         ))
 
-    /// You can set a path that is url that will be captured.
-    /// The subsequent url-path will be mapped to server path.
+    /// You can set a path, which is the URL that will be captured.
+    /// The subsequent url-path will be mapped to the server path.
     /// Uses OwinCompression.DefaultCompressionSettings
     [<Extension>]
     static member MapCompressionModule(app:IAppBuilder, path:string) =