Merge pull request #51 from richardschneider/big-rename

Big rename

Author: richardschneider

IpfsApi.sln renamed to IpfsHttpClient.sln

@@ -13,9 +13,9 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Documentation", "doc\Documentation.csproj", "{F3A32EA9-0B2F-46A3-B47A-33B4C04BD423}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "IpfsApi", "src\IpfsApi.csproj", "{F3C81C57-C283-4E07-B765-DEABCFB22136}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "IpfsHttpClient", "src\IpfsHttpClient.csproj", "{F3C81C57-C283-4E07-B765-DEABCFB22136}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "IpfsApiTests", "test\IpfsApiTests.csproj", "{B459FBC7-4A28-4170-AD83-7348A403407F}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "IpfsHttpClientTests", "test\IpfsHttpClientTests.csproj", "{B459FBC7-4A28-4170-AD83-7348A403407F}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

README.md

@@ -1,23 +1,23 @@
-# net-ipfs-api
+# net-ipfs-http-client
 
 [![build status](https://ci.appveyor.com/api/projects/status/github/richardschneider/net-ipfs-api?branch=master&svg=true)](https://ci.appveyor.com/project/richardschneider/net-ipfs-api) 
-[![Coverage Status](https://coveralls.io/repos/github/richardschneider/net-ipfs-api/badge.svg?branch=master)](https://coveralls.io/github/richardschneider/net-ipfs-api?branch=master)
-[![Version](https://img.shields.io/nuget/v/Ipfs.Api.svg)](https://www.nuget.org/packages/Ipfs.Api)
-[![docs](https://cdn.rawgit.com/richardschneider/net-ipfs-api/master/doc/images/docs-latest-green.svg)](https://richardschneider.github.io/net-ipfs-api/articles/client.html)
+[![Coverage Status](https://coveralls.io/repos/github/richardschneider/net-ipfs-http-client/badge.svg?branch=master)](https://coveralls.io/github/richardschneider/net-ipfs-http-client?branch=master)
+[![Version](https://img.shields.io/nuget/v/Ipfs.Http.Client.svg)](https://www.nuget.org/packages/Ipfs.Http.Client)
+[![docs](https://img.shields.io/badge/docs-latest-green.svg)](https://richardschneider.github.io/net-ipfs-http-client/articles/client.html)
 
 
-A .Net client library for the IPFS HTTP API, implemented in C#. 
-More information, including the Class Reference, is on the [Project](https://richardschneider.github.io/net-ipfs-api/) web site.
+A .Net client library for managing IPFS using the HTTP API protocol. 
+More information, including the Class Reference, is on the [Project](https://richardschneider.github.io/net-ipfs-http-client/) web site.
 
 ![](https://ipfs.io/ipfs/QmQJ68PFMDdAsgCZvA1UVzzn18asVcf7HVvCDgpjiSCAse)
 
 ## Features
 
 - Targets .NET Framework 4.5, .NET Standard 1.4 and .NET Standard 2.0
-- [Asynchronous I/O](https://richardschneider.github.io/net-ipfs-api/articles/async.html) to an IPFS server
-- Supports [cancellation](https://richardschneider.github.io/net-ipfs-api/articles/cancellation.html) of all requests to the IPFS Server
+- [Asynchronous I/O](https://richardschneider.github.io/net-ipfs-http-client/articles/async.html) to an IPFS server
+- Supports [cancellation](https://richardschneider.github.io/net-ipfs-http-client/articles/cancellation.html) of all requests to the IPFS Server
 - Requests that all responses are compressed
-- Comprehensive [documentation](https://richardschneider.github.io/net-ipfs-api/articles/client.html)
+- Comprehensive [documentation](https://richardschneider.github.io/net-ipfs-http-client/articles/client.html)
 - C# style access to the [ipfs core interface](https://richardschneider.github.io/net-ipfs-core/api/Ipfs.CoreApi.html)
   - [Bitswap API](https://richardschneider.github.io/net-ipfs-core/api/Ipfs.CoreApi.IBitswapApi.html)
   - [Block API](https://richardschneider.github.io/net-ipfs-core/api/Ipfs.CoreApi.IBlockApi.html)
@@ -35,17 +35,22 @@ More information, including the Class Reference, is on the [Project](https://ric
 
 ## Getting started
 
-Published releases of IPFS API are available on [NuGet](https://www.nuget.org/packages/ipfs.api/).  To install, run the following command in the [Package Manager Console](https://docs.nuget.org/docs/start-here/using-the-package-manager-console).
+Published releases of IPFS API are available on [NuGet](https://www.nuget.org/packages/ipfs.http.client/).  To install, run the following command in the [Package Manager Console](https://docs.nuget.org/docs/start-here/using-the-package-manager-console).
 
-    PM> Install-Package Ipfs.Api
+    PM> Install-Package Ipfs.Http.Client
 
-For the latest build or older non-released builds see [Continuous Integration](https://github.com/richardschneider/net-ipfs-core/wiki/Continuous-Integration).
+Or using [dotnet](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet?tabs=netcore21)
+
+    > dotnet add package Ipfs.Http.Client
 
 ## IpfsClient
 
-Every IPFS Api is a property of the [IpfsClient](https://richardschneider.github.io/net-ipfs-api/api/Ipfs.Api.IpfsClient.html).  The following example reads a text file
+Every feature of IPFS is a property of the [IpfsClient](https://richardschneider.github.io/net-ipfs-http-client/api/Ipfs.Http.IpfsClient.html).  The following example 
+uses `FileSystem` to read a text file
 
 ```csharp
+using Ipfs.Http;
+
 var ipfs = new IpfsClient();
 
 const string filename = "QmXarR6rgkQ2fDSHjSY5nM2kuCXKYGViky5nohtwgF65Ec/about";
@@ -55,4 +60,4 @@ string text = await ipfs.FileSystem.ReadAllTextAsync(filename);
 # License
 Copyright © 2015-2018 Richard Schneider ([email protected])
 
-The IPFS API library is licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php "Read more about the MIT license form") license. Refer to the [LICENSE](https://github.com/richardschneider/net-ipfs-api/blob/master/LICENSE) file for more information.
+The IPFS API library is licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php "Read more about the MIT license form") license. Refer to the [LICENSE](https://github.com/richardschneider/net-ipfs-http-client/blob/master/LICENSE) file for more information.

appveyor.yml

@@ -55,12 +55,12 @@ build_script:
   - dotnet pack -c %CONFIGURATION% --no-build --no-restore -p:Version=%GitVersion_MajorMinorPatch% -p:AssemblyVersion=%GitVersion_MajorMinorPatch%
 
 after_build:
-  - cmd: appveyor PushArtifact "src\bin\%CONFIGURATION%\Ipfs.Api.%GitVersion_MajorMinorPatch%.nupkg"
+  - cmd: appveyor PushArtifact "src\bin\%CONFIGURATION%\Ipfs.Http.Client.%GitVersion_MajorMinorPatch%.nupkg"
 # Build documentation in doc\_site
 # See https://github.com/dotnet/docfx/issues/1752#issuecomment-308909959
   - set MSBUILD_EXE_PATH=C:\Program Files\dotnet\sdk\2.0.0\MSBuild.dll
   - copy doc\MSBuild.dll.config "C:\Program Files\dotnet\sdk\2.0.0\MSBuild.dll.config" /Y
-  - docfx doc\docfx.json
+  - docfx doc\docfx.json --logLevel Warning
   - 7z a -tzip docs.zip doc\_site
   - appveyor PushArtifact docs.zip
   - if defined git_token gh-pages -d doc\_site -m "new docs %GitVersion_FullSemVer%"
@@ -71,7 +71,7 @@ test_script:
 after_test: 
 # Generate coverage report
     - packages\OpenCover.4.6.519\tools\OpenCover.Console.exe 
-        -register:user -filter:"+[Ipfs.Api*]* -[*Tests]*" 
+        -register:user -filter:"+[Ipfs.Http*]* -[*Tests]*" 
         -target:"c:\Program Files\dotnet\dotnet.exe" 
         -targetargs:"test -c Release --no-build --no-restore --framework netcoreapp2.0 test" 
         -output:coverage.xml  

doc/articles/async.md

@@ -25,7 +25,7 @@ the token is cancelled,
 a [TaskCanceledException](xref:System.Threading.Tasks.TaskCanceledException) 
 will be `thrown`.
 
-Here's a contrived example ([unit test](https://github.com/richardschneider/net-ipfs-api/blob/cancellation/test/CoreApi/CancellationTest.cs)) 
+Here's a contrived example ([unit test](https://github.com/richardschneider/net-ipfs-http-client/blob/cancellation/test/CoreApi/CancellationTest.cs)) 
 that forces the getting of info on the local IPFS server to be cancelled
 
 ```csharp

doc/articles/client.md

@@ -3,7 +3,7 @@
 IPFS is a distributed peer to peer system.  There is no central server!  Typically, each machine (peer) runs 
 a [daemon](daemon.md) that communicates with other peers.
 
-The [IpfsClient](xref:Ipfs.Api.IpfsClient) provides a simple way for your program to access the daemon 
+The [IpfsClient](xref:Ipfs.Http.IpfsClient) provides a simple way for your program to access the daemon 
 via the [IPFS HTTP API](https://docs.ipfs.io/reference/api/http/) protocol. The client 
 should be used as a shared object in your program, much like [HttpClient](xref:System.Net.Http.HttpClient).  It is 
 thread safe (re-entrant) and conserves sockets and TCP connections when only one instance is used.

doc/articles/envvars.md

@@ -5,4 +5,4 @@ are used  to control the behaviour of the library.  They override the default va
 
 | Name | Description |
 | --- | --- |
-| IpfsHttpUrl | The [default URL](xref:Ipfs.Api.IpfsClient.DefaultApiUri) to the IPFS HTTP API [daemon](daemon.md).
+| IpfsHttpUrl | The [default URL](xref:Ipfs.Http.IpfsClient.DefaultApiUri) to the IPFS HTTP API [daemon](daemon.md).

doc/articles/intro.md

@@ -1,8 +1,8 @@
-# IPFS API
+# IPFS HTTP Client
 
 A .Net client library for the IPFS HTTP API, implemented in C#. It allows you to access the features of [IPFS](https://ipfs.io/).
 
-The source code is on [GitHub](https://github.com/richardschneider/net-ipfs-api) and the 
-package is published on [NuGet](https://www.nuget.org/packages/Ipfs.Api).
+The source code is on [GitHub](https://github.com/richardschneider/net-ipfs-http-client) and the 
+package is published on [NuGet](https://www.nuget.org/packages/ipfs.http.client).
 
 ![](https://ipfs.io/ipfs/QmQJ68PFMDdAsgCZvA1UVzzn18asVcf7HVvCDgpjiSCAse)

doc/articles/toc.yml

@@ -11,4 +11,4 @@
 - name: IPFS daemon
   href: daemon.md
 - name: Class Reference
-  href: ../api/Ipfs.Api.yml
+  href: ../api/Ipfs.Http.yml

doc/docfx.json

@@ -1,86 +1,86 @@
-{
-  "metadata": [
-    {
-      "src": [
-        {
-          "files": [
-            "src/**.csproj"
-          ],
-          "exclude": [
-            "**/obj/**",
-            "**/bin/**",
-            "_site/**"
-          ],
-          "src": ".."
-        }
-      ],
-      "properties": {
-        "TargetFramework": "net45"
-      },
-
-      "dest": "api"
-    }
-  ],
-  "build": {
-    "content": [
-      {
-        "files": [
-          "api/**.yml",
-          "api/index.md"
-        ]
-      },
-      {
-        "files": [
-          "articles/**.md",
-          "articles/**/toc.yml",
-          "toc.yml",
-          "*.md"
-        ],
-        "exclude": [
-          "obj/**",
-          "_site/**"
-        ]
-      }
-    ],
-    "resource": [
-      {
-        "files": [
-          "images/**"
-        ],
-        "exclude": [
-          "obj/**",
-          "_site/**"
-        ]
-      }
-    ],
-    "overwrite": [
-      {
-        "files": [
-          "apidoc/**.md"
-        ],
-        "exclude": [
-          "obj/**",
-          "_site/**"
-        ]
-      }
-    ],
-    "xref": [
-      "../packages/msdn.4.5.2.0.1.0-alpha-1611021200/content/msdn.4.5.2.zip",
-	    "https://richardschneider.github.io/net-ipfs-core/xrefmap.yml"
-    ],
-    "globalMetadata" : {
-      "_appTitle": "IPFS API documentation",
-      "_appFooter": "Generated by DocFX",
-	    "_appFaviconPath": "images/ipfs-favicon.ico",
-      "_appLogoPath":  "images/ipfs-logo.svg"
-	  },
-    "dest": "_site",
-    "globalMetadataFiles": [],
-    "fileMetadataFiles": [],
-    "template": [
-      "default"
-    ],
-    "postProcessors": [],
-    "noLangKeyword": false
-  }
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "src/**.csproj"
+          ],
+          "exclude": [
+            "**/obj/**",
+            "**/bin/**",
+            "_site/**"
+          ],
+          "src": ".."
+        }
+      ],
+      "properties": {
+        "TargetFramework": "net45"
+      },
+
+      "dest": "api"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "api/**.yml",
+          "api/index.md"
+        ]
+      },
+      {
+        "files": [
+          "articles/**.md",
+          "articles/**/toc.yml",
+          "toc.yml",
+          "*.md"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "overwrite": [
+      {
+        "files": [
+          "apidoc/**.md"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "xref": [
+      "../packages/msdn.4.5.2.0.1.0-alpha-1611021200/content/msdn.4.5.2.zip",
+	    "https://richardschneider.github.io/net-ipfs-core/xrefmap.yml"
+    ],
+    "globalMetadata" : {
+      "_appTitle": "IPFS HTP Client documentation",
+      "_appFooter": "Generated by DocFX",
+	    "_appFaviconPath": "images/ipfs-favicon.ico",
+      "_appLogoPath":  "images/ipfs-logo.svg"
+	  },
+    "dest": "_site",
+    "globalMetadataFiles": [],
+    "fileMetadataFiles": [],
+    "template": [
+      "default"
+    ],
+    "postProcessors": [],
+    "noLangKeyword": false
+  }
 }

doc/index.md

@@ -1,12 +1,12 @@
-# IPFS API
-
-A .Net client library to access the IPFS, it implements the [IPFS Core API](https://github.com/ipfs/interface-ipfs-core). 
-The source code is on [GitHub](https://github.com/richardschneider/net-ipfs-api) and the 
-package is published on [NuGet](https://www.nuget.org/packages/Ipfs.Api).
-
-The interplanetary file system is the permanent web. It is a new hypermedia distribution protocol, addressed by content and identities. IPFS enables the creation of completely distributed applications. It aims to make the web faster, safer, and more open.
-
-- [Articles](articles/intro.md) on using the API
-- [API Documentation](api/Ipfs.Api.yml) describes the core objects in detail  
-
-[![IPFS Core API](https://github.com/ipfs/interface-ipfs-core/raw/master/img/badge.png)](https://github.com/ipfs/interface-ipfs-core)
+# IPFS HTTP Client
+
+A .Net client library to access the IPFS, it implements the [IPFS Core API](https://github.com/ipfs/interface-ipfs-core). 
+The source code is on [GitHub](https://github.com/richardschneider/net-ipfs-http-client) and the 
+package is published on [NuGet](https://www.nuget.org/packages/Ipfs.Http.Client).
+
+The interplanetary file system is the permanent web. It is a new hypermedia distribution protocol, addressed by content and identities. IPFS enables the creation of completely distributed applications. It aims to make the web faster, safer, and more open.
+
+- [Articles](articles/intro.md) on using the API
+- [API Documentation](api/Ipfs.Http.yml) describes the core objects in detail  
+
+[![IPFS Core API](https://github.com/ipfs/interface-ipfs-core/raw/master/img/badge.png)](https://github.com/ipfs/interface-ipfs-core)