Add Fake.Net.Http documentation

Author: vlukash

FAKE.sln

@@ -85,6 +85,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "markdown", "markdown", "{B9
 		help\markdown\legacy-core-targets.md = help\markdown\legacy-core-targets.md
 		help\markdown\legacy-gettingstarted.md = help\markdown\legacy-gettingstarted.md
 		help\markdown\legacy-index.md = help\markdown\legacy-index.md
+		help\markdown\net-http.md = help\markdown\net-http.md
 		help\markdown\testing-sonarqube.md = help\markdown\testing-sonarqube.md
 		help\markdown\todo-androidpublisher.md = help\markdown\todo-androidpublisher.md
 		help\markdown\todo-azurecloudservices.md = help\markdown\todo-azurecloudservices.md

help/markdown/net-http.md

@@ -0,0 +1,67 @@
+# Downloading Files Over HTTP
+
+The `Fake.Net.Http` module provides a functionality to download files over HTTP.
+
+[API-Reference](apidocs/fake-net-http.html)
+
+## Including the Fake.Net.Http dependency
+
+In order to open the `Fake.Net.Http` module from a build script you have to add a `Fake.Net.Http` dependency into your
+`paket.dependencies` file:
+
+    group NetcoreBuild
+        source https://api.nuget.org/v3/index.json
+
+        nuget Fake.Net.Http prerelease
+
+        .... other dependencies, like
+        nuget Fake.Core.Target prerelease
+
+Please see more details on referencing FAKE 5 modules [here](apidocs/fake-fake5-modules.html).
+
+## Downloading a Single File
+
+To download a single file over HTTP use `downloadFile` from the Http module:
+
+    open Fake.Net
+    open Fake.Core
+
+    Target.Create "DownloadFile" (fun _ ->
+        let absoluteFilePath = Http.downloadFile "/tmp/5.zip" @"http://ipv4.download.thinkbroadband.com/5MB.zip"
+        printfn "File path: %s" absoluteFilePath
+    )
+    
+A console output should be:
+
+    Downloading [http://ipv4.download.thinkbroadband.com/5MB.zip] ...
+    Download succeeded
+    File path: /tmp/5.zip
+
+## Downloading Multiple Files
+
+To download multiple files in parallel use `downloadFiles` from the Http module:
+
+    open Fake.Net
+    open Fake.Core
+
+    Target.Create "DownloadFiles" (fun _ ->
+        let files: Http.DownloadParameters list = [
+                    {Path = "/tmp/5.zip"; Uri = "http://ipv4.download.thinkbroadband.com/5MB.zip"};
+                    {Path = "/tmp/10.zip"; Uri = "http://ipv4.download.thinkbroadband.com/10MB.zip"}]
+        let filePaths = Http.downloadFiles files
+        printfn "File paths: %A" filePaths
+    )
+    
+A console output should be:
+
+    Downloading [http://ipv4.download.thinkbroadband.com/5MB.zip] ...
+    Downloading [http://ipv4.download.thinkbroadband.com/10MB.zip] ...
+    Download succeeded
+    File paths: ["/tmp/5.zip"; "/tmp/10.zip"]
+
+## More Details
+
+* `downloadFile` and `downloadFiles` throw an Exception and fail a FAKE Target if any error occurs (invalid URI, invalid local file
+   path/permissions, etc.)
+
+* file with the same name will be overwritten if exists in the target location

help/templates/template.cshtml

@@ -112,6 +112,12 @@
 																<li><a href="@(prefix)apidocs/fake-dotnet-paket.html">Paket</a></li>
 															</ul>
 														</li>
+														<li>
+															<a href="@(prefix)apidocs/index.html#Fake.Net">Net</a>
+															<ul>
+																<li><a href="@(prefix)net-http.html">Http</a></li>
+															</ul>
+														</li>
 														<li>
 															<a href="@(prefix)apidocs/index.html#Fake.Tools.Git">Tools</a>
 															<ul>
@@ -297,4 +303,4 @@
 			<script src="@(prefix)assets/js/main.js"></script>
 
 	</body>
-</html>
+</html>

src/app/Fake.Net.Http/AssemblyInfo.fs

@@ -5,13 +5,13 @@ open System.Reflection
 [<assembly: AssemblyTitleAttribute("FAKE - F# Make HTTP Client")>]
 [<assembly: AssemblyProductAttribute("FAKE - F# Make")>]
 [<assembly: AssemblyVersionAttribute("5.0.0")>]
-[<assembly: AssemblyInformationalVersionAttribute("5.0.0-beta010")>]
+[<assembly: AssemblyInformationalVersionAttribute("5.0.0")>]
 [<assembly: AssemblyFileVersionAttribute("5.0.0")>]
 do ()
 
 module internal AssemblyVersionInformation =
     let [<Literal>] AssemblyTitle = "FAKE - F# Make HTTP Client"
     let [<Literal>] AssemblyProduct = "FAKE - F# Make"
     let [<Literal>] AssemblyVersion = "5.0.0"
-    let [<Literal>] AssemblyInformationalVersion = "5.0.0-beta010"
+    let [<Literal>] AssemblyInformationalVersion = "5.0.0"
     let [<Literal>] AssemblyFileVersion = "5.0.0"