5.0.0 site rebuild

pimbrouwers · pimbrouwers · commit d454b3a944bf · 2025-01-28T08:56:08.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [5.0.0] - ????-??-??
+## [5.0.0] - 2025-01-28
 
 ### Added
 
diff --git a/docs/docs/authentication.html b/docs/docs/authentication.html
@@ -60,4 +60,4 @@ <h3 id="terminate-authenticated-session">Terminate authenticated session</h3>
     Response.signOutAndRedirect authScheme redirectTo
 </code></pre>
 <p><a href="example-hello-world.html">Next: Example - Hello World</a></p>
-</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2024 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
+</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
diff --git a/docs/docs/cross-site-request-forgery.html b/docs/docs/cross-site-request-forgery.html
@@ -69,4 +69,4 @@ <h2 id="falco-xsrf-support">Falco XSRF Support</h2>
     Request.mapFormSecure mapPerson Response.ofJson handleInvalid
 </code></pre>
 <p><a href="authentication.html">Next: Authentication</a></p>
-</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2024 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
+</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
diff --git a/docs/docs/example-dependency-injection.html b/docs/docs/example-dependency-injection.html
@@ -59,4 +59,4 @@ <h2 id="registering-the-dependency">Registering the Dependency</h2>
 <h2 id="wrapping-up">Wrapping Up</h2>
 <p>Now that we're finished introducing dependency injection, let's move on to a real world example by integrating with an external view engine.</p>
 <p><a href="example-external-view-engine.html">Next: Example - External View Engine</a></p>
-</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2024 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
+</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
diff --git a/docs/docs/example-external-view-engine.html b/docs/docs/example-external-view-engine.html
@@ -102,7 +102,4 @@ <h2 id="registering-the-template-engine">Registering the Template Engine</h2>
 
     0 // Exit code
 </code></pre>
-<h2 id="wrapping-up">Wrapping Up</h2>
-<p>Having dabbled with creating HTML applications, now let's set our sights on creating RESTful APIs.</p>
-<p><a href="example-basic-rest-api.html">Next: Example - Basic REST API</a></p>
-</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2024 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
+</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
diff --git a/docs/docs/example-hello-world-mvc.html b/docs/docs/example-hello-world-mvc.html
@@ -160,4 +160,4 @@ <h2 id="web-server">Web Server</h2>
 <h2 id="wrapping-up">Wrapping Up</h2>
 <p>This example was a leap ahead from our basic hello world. But having followed this, you know understand many of the patterns you'll need to know to build end-to-end server applications with Falco. Unsurprisingly, the entire program fits inside 118 LOC. One of the magnificent benefits of writing code in F#.</p>
 <p><a href="example-dependency-injection.html">Next: Example - Dependency Injection</a></p>
-</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2024 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
+</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
diff --git a/docs/docs/example-hello-world.html b/docs/docs/example-hello-world.html
@@ -13,18 +13,16 @@ <h2 id="code-overview">Code Overview</h2>
 open Microsoft.AspNetCore.Builder
 // ^-- this import adds many useful extensions
 
-let endpoints =
-    [
-        get &quot;/&quot; (Response.ofPlainText &quot;Hello World!&quot;)
-        // ^-- associate GET / to plain text HttpHandler
-    ]
-
 let wapp = WebApplication.Create()
 
 wapp.UseRouting()
-    .UseFalco(endpoints)
+    .UseFalco([
+    // ^-- activate Falco endpoint source
+        get &quot;/&quot; (Response.ofPlainText &quot;Hello World!&quot;)
+        // ^-- associate GET / to plain text HttpHandler
+    ])
+    .Run(Response.ofPlainText &quot;Not found&quot;)
     // ^-- activate Falco endpoint source
-    .Run()
 </code></pre>
 <p>First, we open the required namespaces. <code>Falco</code> bring into scope the ability to activate the library and some other extension methods to make the fluent API more user-friendly.</p>
 <p><code>Microsoft.AspNetCore.Builder</code> enables us to create web applications in a number of ways, we're using <code>WebApplication.Create()</code> above. It also adds many other useful extension methods, that you'll see later.</p>
@@ -35,4 +33,4 @@ <h2 id="code-overview">Code Overview</h2>
 <li>Run the app.</li>
 </ul>
 <p><a href="example-hello-world-mvc.html">Next: Example - Hello World MVC</a></p>
-</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2024 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
+</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
diff --git a/docs/docs/get-started.html b/docs/docs/get-started.html
@@ -45,4 +45,4 @@ <h2 id="manually-installing">Manually installing</h2>
 <h2 id="sample-applications">Sample Applications</h2>
 <p>Code is worth a thousand words. For the most up-to-date usage, the <a href="https://github.com/pimbrouwers/Falco/tree/master/examples/">examples</a> directory contains a few sample applications.</p>
 <p><a href="routing.html">Next: Routing</a></p>
-</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2024 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
+</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
diff --git a/docs/docs/index.html b/docs/docs/index.html
@@ -14,4 +14,4 @@ <h2 id="guides">Guides</h2>
 <li><a href="authentication.html">Security</a></li>
 <li><a href="example-hello-world.html">Examples</a></li>
 </ul>
-</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2024 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
+</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
diff --git a/docs/docs/markup.html b/docs/docs/markup.html
@@ -268,4 +268,4 @@ <h2 id="svg">SVG</h2>
 let svg = renderNode svgDrawing
 </code></pre>
 <p><a href="cross-site-request-forgery.html">Next: Cross-site Request Forgery (XSRF)</a></p>
-</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2024 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
+</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
diff --git a/docs/docs/migrating-from-v4-to-v5.html b/docs/docs/migrating-from-v4-to-v5.html
@@ -132,4 +132,4 @@ <h2 id="crypto-module-removed"><code>Crypto</code> module removed</h2>
 <p>The Crypto module provided functionality for: random numbers, salt generation and key derivation. The code in this module was really a veneer on top of the cryptographic providers in the base library. Extracting this code into your project would be dead simple. The <a href="https://github.com/pimbrouwers/Falco/blob/25d828d832c0fde2dfff04775bea1eced9050458/src/Falco/Security.fs#L3">source</a> is permalinked here for such purposes.</p>
 <h2 id="auth-module-removed"><code>Auth</code> module removed</h2>
 <p>The <code>Auth</code> module functionality was ported one-to-one to the <code>Response</code> module.</p>
-</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2024 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
+</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
diff --git a/docs/docs/request.html b/docs/docs/request.html
@@ -201,4 +201,4 @@ <h2 id="json">JSON</h2>
     Request.mapJsonOption options handleOk
 </code></pre>
 <p><a href="markup.html">Next: View engine</a></p>
-</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2024 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
+</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
diff --git a/docs/docs/response.html b/docs/docs/response.html
@@ -108,4 +108,4 @@ <h3 id="add-a-cookie-to-the-response">Add a cookie to the response</h3>
     &gt;&gt; Response.ofPlainText &quot;Hello world&quot;
 </code></pre>
 <p><a href="request.html">Next: Accessing request data</a></p>
-</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2024 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
+</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
diff --git a/docs/docs/routing.html b/docs/docs/routing.html
@@ -110,4 +110,4 @@ <h2 id="multi-method-endpoints">Multi-method Endpoints</h2>
     .Run()
 </code></pre>
 <p><a href="response.html">Next: Writing responses</a></p>
-</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2024 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
+</main></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
diff --git a/docs/index.html b/docs/index.html
@@ -5,32 +5,24 @@
 <p><a href="https://www.nuget.org/packages/Falco"><img src="https://img.shields.io/nuget/v/Falco.svg" alt="NuGet Version" /></a>
 <a href="https://github.com/pimbrouwers/Falco/actions/workflows/build.yml"><img src="https://github.com/pimbrouwers/Falco/actions/workflows/build.yml/badge.svg" alt="build" /></a></p>
 <pre><code class="language-fsharp">open Falco
-open Falco.Routing
 open Microsoft.AspNetCore.Builder
 
-let endpoints =
-    [
-        get &quot;/&quot; (Response.ofPlainText &quot;Hello World!&quot;)
-    ]
-
 let wapp = WebApplication.Create()
 
-wapp.UseRouting()
-    .UseFalco(endpoints)
-    .Run()
+wapp.Run(Response.ofPlainText &quot;Hello world&quot;)
 </code></pre>
 <p><a href="https://github.com/pimbrouwers/Falco">Falco</a> is a toolkit for building fast and functional-first web applications using F#. You can think of it as <a href="https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-8.0&amp;tabs=visual-studio">minimal API</a> on <em>steroids</em>.</p>
 <ul>
-<li>Built upon the high-performance components of ASP.NET Core.</li>
-<li>Optimized for building full-stack web applications quickly.</li>
+<li>Designed for building pure F# full-stack web applications.</li>
+<li>Built on the high-performance components of ASP.NET Core.</li>
 <li>Seamlessly integrates with existing .NET Core middleware and libraries.</li>
 </ul>
 <h2 id="key-features">Key Features</h2>
 <ul>
-<li>Asynchronous <a href="documentation/response.html">request handling</a>.</li>
 <li>Simple and powerful <a href="documentation/routing.html">routing</a> API.</li>
 <li>Uniform API for <a href="documentation/request.html">accessing <em>any</em> request data</a>.</li>
 <li>Native F# <a href="documentation/markup.html">view engine</a>.</li>
+<li>Asynchronous <a href="documentation/response.html">request handling</a>.</li>
 <li><a href="documentation/authentication.html">Authentication</a> and <a href="documentation/cross-site-request-forgery.html">security</a> utilities.</li>
 <li>Built-in support for <a href="documentation/request.html#multipartform-data-binding">large uploads</a> and <a href="documentation/response.html#content-disposition">binary responses</a>.</li>
 </ul>
@@ -41,9 +33,7 @@ <h2 id="design-goals">Design Goals</h2>
 <li>Can be easily learned.</li>
 </ul>
 <h2 id="learn">Learn</h2>
-<p>The best way to get started is by visiting the <a href="https://falcoframework.com/docs">documentation</a>. For questions and support please use <a href="https://github.com/pimbrouwers/Falco/discussions">discussions</a>. The issue list of this repo is <strong>exclusively</strong> for bug reports and feature requests. For chronological updates refer to the <a href="CHANGELOG.html">changelog</a> is the best place to find chronological updates.</p>
-<p>If you want to stay in touch, feel free to reach out on <a href="https://twitter.com/falco_framework">Twitter</a>.</p>
-<p>Have an article or video that you want to share? We'd love to hear from you! To add your content, visit this <a href="https://github.com/pimbrouwers/Falco/discussions/82">discussion</a>.</p>
+<p>The best way to get started is by visiting the <a href="https://falcoframework.com/docs">documentation</a>. For questions and support please use <a href="https://github.com/pimbrouwers/Falco/discussions">discussions</a>. For chronological updates refer to the <a href="CHANGELOG.html">changelog</a> is the best place to find chronological updates.</p>
 <h3 id="related-libraries">Related Libraries</h3>
 <ul>
 <li><a href="https://github.com/pimbrouwers/Falco.Markup">Falco.Markup</a> - an XML markup module primary used as the syntax for <a href="https://www.falcoframework.com/docs/markup.html">authoring HTML with Falco</a>.</li>
@@ -53,7 +43,6 @@ <h3 id="related-libraries">Related Libraries</h3>
 </ul>
 <h3 id="community-projects">Community Projects</h3>
 <ul>
-<li><a href="https://github.com/pimbrouwers/FalcoJournal">FalcoJournal</a> - A bullet journal built with Falco, .NET 5.x and ASP.NET Core.</li>
 <li><a href="https://github.com/adelarsq/falco_graphql_sample">Falco GraphQL Sample</a> - A sample showing how to use GraphQL on Falco using .NET 6.</li>
 <li><a href="https://github.com/jasiozet/falco-api-with-tests-template">Falco API with Tests Sample</a> - A sample project using Falco and unit testing.</li>
 <li><a href="https://github.com/galassie/FalcoSample">Falco + SQLite + Donald</a> - A demo project using Falco, <a href="https://github.com/pimbrouwers/Donald">Donald</a>, and SQLite</li>
@@ -68,15 +57,14 @@ <h3 id="videos">Videos</h3>
 <li>Ben Gobeil - <a href="https://youtu.be/DTy5gIUWvpo">Why I'm Using Falco Instead Of Saturn | How To Switch Your Backend In SAFE Stack | StonkWatch Ep.13</a></li>
 </ul>
 <h2 id="contribute">Contribute</h2>
-<p>Thank you for considering contributing to Falco, and to those who have already contributed! We appreciate (and actively resolve) PRs of all shapes and sizes.</p>
 <p>We kindly ask that before submitting a pull request, you first submit an <a href="https://github.com/pimbrouwers/Falco/issues">issue</a> or open a <a href="https://github.com/pimbrouwers/Falco/discussions">discussion</a>.</p>
 <p>If functionality is added to the API, or changed, please kindly update the relevant <a href="docs">document</a>. Unit tests must also be added and/or updated before a pull request can be successfully merged.</p>
-<p>Only pull requests which pass all build checks and comply with the general coding guidelines can be approved.</p>
+<p>Only pull requests which pass all build checks and comply with the general coding standard can be approved.</p>
 <p>If you have any further questions, submit an <a href="https://github.com/pimbrouwers/Falco/issues">issue</a> or open a <a href="https://github.com/pimbrouwers/Falco/discussions">discussion</a> or reach out on <a href="https://twitter.com/falco_framework">Twitter</a>.</p>
 <h2 id="why-falco">Why &quot;Falco&quot;?</h2>
 <p><a href="https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel">Kestrel</a> has been a game changer for the .NET web stack. In the animal kingdom, &quot;Kestrel&quot; is a name given to several members of the falcon genus. Also known as &quot;Falco&quot;.</p>
 <h2 id="find-a-bug">Find a bug?</h2>
 <p>There's an <a href="https://github.com/pimbrouwers/Falco/issues">issue</a> for that.</p>
 <h2 id="license">License</h2>
-<p>Built with ♥ by <a href="https://github.com/pimbrouwers">Pim Brouwers</a> in Toronto, ON. Licensed under <a href="https://github.com/pimbrouwers/Falco/blob/master/LICENSE">Apache License 2.0</a>.</p>
-</main></div></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2024 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
+<p>Licensed under <a href="https://github.com/pimbrouwers/Falco/blob/master/LICENSE">Apache License 2.0</a>.</p>
+</main></div></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>
