split up readme files per adapter

mvdgun · mvdgun · commit 9e0dbec27207 · 2024-02-12T14:38:23.000-04:00
diff --git a/FileSystem.Adapters.AmazonS3/FileSystem.Adapters.AmazonS3.csproj b/FileSystem.Adapters.AmazonS3/FileSystem.Adapters.AmazonS3.csproj
@@ -13,7 +13,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <None Include="..\README.md" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/FileSystem.Adapters.AmazonS3/README.md b/FileSystem.Adapters.AmazonS3/README.md
@@ -0,0 +1,20 @@
+# SharpGrip FileSystem AmazonS3 adapter [![NuGet](https://img.shields.io/nuget/v/SharpGrip.FileSystem.Adapters.AmazonS3)](https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.AmazonS3)
+
+## Installation
+
+Reference NuGet package `SharpGrip.FileSystem.Adapters.AmazonS3` (https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.AmazonS3).
+
+## Usage
+
+```
+// Amazon connection.
+var amazonClient = new AmazonS3Client("awsAccessKeyId", "awsSecretAccessKey", RegionEndpoint.USEast2);
+
+var adapters = new List<IAdapter>
+{
+    new AmazonS3Adapter("amazon1", "/Files", amazonClient, "bucketName1")
+    new AmazonS3Adapter("amazon2", "/Files", amazonClient, "bucketName2")
+};
+
+var fileSystem = new FileSystem(adapters);
+```
diff --git a/FileSystem.Adapters.AzureBlobStorage/FileSystem.Adapters.AzureBlobStorage.csproj b/FileSystem.Adapters.AzureBlobStorage/FileSystem.Adapters.AzureBlobStorage.csproj
@@ -13,7 +13,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <None Include="..\README.md" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/FileSystem.Adapters.AzureBlobStorage/README.md b/FileSystem.Adapters.AzureBlobStorage/README.md
@@ -0,0 +1,21 @@
+﻿# SharpGrip FileSystem AzureBlobStorage adapter [![NuGet](https://img.shields.io/nuget/v/SharpGrip.FileSystem.Adapters.AzureBlobStorage)](https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.AzureBlobStorage)
+
+## Installation
+
+Reference NuGet package `SharpGrip.FileSystem.Adapters.AzureBlobStorage` (https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.AzureBlobStorage).
+
+## Usage
+
+```
+// Azure connection.
+var blobServiceClient = new BlobServiceClient("connectionString");
+var azureClient = blobServiceClient.GetBlobContainerClient("blobContainerName");
+
+var adapters = new List<IAdapter>
+{
+    new LocalAdapter("local", "/var/files"),
+    new AzureBlobStorageAdapter("azure", "/Files", azureClient)
+};
+
+var fileSystem = new FileSystem(adapters);
+```
diff --git a/FileSystem.Adapters.AzureFileStorage/FileSystem.Adapters.AzureFileStorage.csproj b/FileSystem.Adapters.AzureFileStorage/FileSystem.Adapters.AzureFileStorage.csproj
@@ -13,7 +13,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <None Include="..\README.md" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/FileSystem.Adapters.AzureFileStorage/README.md b/FileSystem.Adapters.AzureFileStorage/README.md
@@ -0,0 +1,20 @@
+﻿# SharpGrip FileSystem AzureFileStorage adapter [![NuGet](https://img.shields.io/nuget/v/SharpGrip.FileSystem.Adapters.AzureFileStorage)](https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.AzureFileStorage)
+
+## Installation
+
+Reference NuGet package `SharpGrip.FileSystem.Adapters.AzureFileStorage` (https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.AzureFileStorage).
+
+## Usage
+
+```
+// Azure connection.
+var azureClient = new ShareClient("connectionString", "shareName");
+
+var adapters = new List<IAdapter>
+{
+    new LocalAdapter("local", "/var/files"),
+    new AzureFileStorageAdapter("azure", "/Files", azureClient)
+};
+
+var fileSystem = new FileSystem(adapters);
+```
diff --git a/FileSystem.Adapters.Dropbox/FileSystem.Adapters.Dropbox.csproj b/FileSystem.Adapters.Dropbox/FileSystem.Adapters.Dropbox.csproj
@@ -13,7 +13,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <None Include="..\README.md" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/FileSystem.Adapters.Dropbox/README.md b/FileSystem.Adapters.Dropbox/README.md
@@ -0,0 +1,20 @@
+﻿# SharpGrip FileSystem Dropbox adapter [![NuGet](https://img.shields.io/nuget/v/SharpGrip.FileSystem.Adapters.Dropbox)](https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.Dropbox)
+
+## Installation
+
+Reference NuGet package `SharpGrip.FileSystem.Adapters.Dropbox` (https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.Dropbox).
+
+## Usage
+
+```
+// Dropbox connection.
+var dropboxClient = new DropboxClient("oAuth2AccessToken");
+
+var adapters = new List<IAdapter>
+{
+    new LocalAdapter("local", "/var/files"),
+    new DropboxAdapter("dropbox", "/Files", dropboxClient)
+};
+
+var fileSystem = new FileSystem(adapters);
+```
diff --git a/FileSystem.Adapters.Ftp/FileSystem.Adapters.Ftp.csproj b/FileSystem.Adapters.Ftp/FileSystem.Adapters.Ftp.csproj
@@ -13,7 +13,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <None Include="..\README.md" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/FileSystem.Adapters.Ftp/README.md b/FileSystem.Adapters.Ftp/README.md
@@ -0,0 +1,20 @@
+﻿# SharpGrip FileSystem Ftp adapter [![NuGet](https://img.shields.io/nuget/v/SharpGrip.FileSystem.Adapters.Ftp)](https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.Ftp)
+
+## Installation
+
+Reference NuGet package `SharpGrip.FileSystem.Adapters.Ftp` (https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.Ftp).
+
+## Usage
+
+```
+// FTP connection.
+var ftpClient = new AsyncFtpClient("hostname", "username", "password");
+
+var adapters = new List<IAdapter>
+{
+    new LocalAdapter("local", "/var/files"),
+    new FtpAdapter("ftp", "/var/files", ftpClient)
+};
+
+var fileSystem = new FileSystem(adapters);
+```
diff --git a/FileSystem.Adapters.GoogleCloudStorage/FileSystem.Adapters.GoogleCloudStorage.csproj b/FileSystem.Adapters.GoogleCloudStorage/FileSystem.Adapters.GoogleCloudStorage.csproj
@@ -13,7 +13,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <None Include="..\README.md" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/FileSystem.Adapters.GoogleCloudStorage/README.md b/FileSystem.Adapters.GoogleCloudStorage/README.md
@@ -0,0 +1,21 @@
+﻿# SharpGrip FileSystem GoogleCloudStorage adapter [![NuGet](https://img.shields.io/nuget/v/SharpGrip.FileSystem.Adapters.GoogleCloudStorage)](https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.GoogleCloudStorage)
+
+## Installation
+
+Reference NuGet package `SharpGrip.FileSystem.Adapters.GoogleCloudStorage` (https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.GoogleCloudStorage).
+
+## Usage
+
+```
+// Google connection.
+var credential = GoogleCredential.FromFile("path/to/credential/file");
+var storageClient = await StorageClient.CreateAsync(credential);
+
+var adapters = new List<IAdapter>
+{
+    new LocalAdapter("local", "/var/files"),
+    new GoogleCloudStorageAdapter(prefix, rootPath, storageClient, "bucketName", configuration);
+};
+
+var fileSystem = new FileSystem(adapters);
+```
diff --git a/FileSystem.Adapters.GoogleDrive/FileSystem.Adapters.GoogleDrive.csproj b/FileSystem.Adapters.GoogleDrive/FileSystem.Adapters.GoogleDrive.csproj
@@ -13,7 +13,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <None Include="..\README.md" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/FileSystem.Adapters.GoogleDrive/README.md b/FileSystem.Adapters.GoogleDrive/README.md
@@ -0,0 +1,33 @@
+﻿# SharpGrip FileSystem GoogleDrive adapter [![NuGet](https://img.shields.io/nuget/v/SharpGrip.FileSystem.Adapters.GoogleDrive)](https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.GoogleDrive)
+
+## Installation
+
+Reference NuGet package `SharpGrip.FileSystem.Adapters.GoogleDrive` (https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.GoogleDrive).
+
+## Usage
+
+```
+// Google connection.
+await using var stream = new FileStream("path/to/credentials.json", FileMode.Open, FileAccess.Read);
+const string tokenPath = "path/to/token/directory";
+var credential = await GoogleWebAuthorizationBroker.AuthorizeAsync(
+    (await GoogleClientSecrets.FromStreamAsync(stream)).Secrets,
+    new[] {DriveService.Scope.Drive},
+    "user",
+    CancellationToken.None,
+    new FileDataStore(tokenPath, true));
+
+var googleDriveClient = new DriveService(new BaseClientService.Initializer
+{
+    HttpClientInitializer = credential,
+    ApplicationName = "Test"
+});
+
+var adapters = new List<IAdapter>
+{
+    new LocalAdapter("local", "/var/files"),
+    new GoogleDriveAdapter("google-drive", "/Files", googleDriveClient)
+};
+
+var fileSystem = new FileSystem(adapters);
+```
diff --git a/FileSystem.Adapters.MicrosoftOneDrive/FileSystem.Adapters.MicrosoftOneDrive.csproj b/FileSystem.Adapters.MicrosoftOneDrive/FileSystem.Adapters.MicrosoftOneDrive.csproj
@@ -13,7 +13,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <None Include="..\README.md" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/FileSystem.Adapters.MicrosoftOneDrive/README.md b/FileSystem.Adapters.MicrosoftOneDrive/README.md
@@ -0,0 +1,32 @@
+﻿# SharpGrip FileSystem MicrosoftOneDrive adapter [![NuGet](https://img.shields.io/nuget/v/SharpGrip.FileSystem.Adapters.MicrosoftOneDrive)](https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.MicrosoftOneDrive)
+
+## Installation
+
+Reference NuGet package `SharpGrip.FileSystem.Adapters.MicrosoftOneDrive` (https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.MicrosoftOneDrive).
+
+## Usage
+
+```
+// Microsoft connection.
+var scopes = new[] {"https://graph.microsoft.com/.default"};
+var tenantId = "tenantId";
+var confidentialClient = ConfidentialClientApplicationBuilder
+    .Create("clientId")
+    .WithAuthority($"https://login.microsoftonline.com/{tenantId}/v2.0")
+    .WithClientSecret("clientSecret")
+    .Build();
+var oneDriveClient = new GraphServiceClient(new DelegateAuthenticationProvider(async requestMessage =>
+    {
+        var authResult = await confidentialClient.AcquireTokenForClient(scopes).ExecuteAsync();
+        requestMessage.Headers.Authorization = new AuthenticationHeaderValue("Bearer", authResult.AccessToken);
+    })
+);
+
+var adapters = new List<IAdapter>
+{
+    new LocalAdapter("local", "/var/files"),
+    new MicrosoftOneDriveAdapter("onedrive", "/Files", oneDriveClient, "driveId")
+};
+
+var fileSystem = new FileSystem(adapters);
+```
diff --git a/FileSystem.Adapters.Sftp/FileSystem.Adapters.Sftp.csproj b/FileSystem.Adapters.Sftp/FileSystem.Adapters.Sftp.csproj
@@ -13,7 +13,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <None Include="..\README.md" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/FileSystem.Adapters.Sftp/README.md b/FileSystem.Adapters.Sftp/README.md
@@ -0,0 +1,23 @@
+﻿# SharpGrip FileSystem Sftp adapter [![NuGet](https://img.shields.io/nuget/v/SharpGrip.FileSystem.Adapters.Sftp)](https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.Sftp)
+
+## Installation
+
+Reference NuGet package `SharpGrip.FileSystem.Adapters.Sftp` (https://www.nuget.org/packages/SharpGrip.FileSystem.Adapters.Sftp).
+
+## Usage
+
+```
+// SFTP connection.
+var privateKeyFile = new PrivateKeyFile("/home/userName/.ssh/id_rsa");
+var privateKeyAuthenticationMethod = new PrivateKeyAuthenticationMethod("userName", privateKeyFile);
+var sftpConnectionInfo = new ConnectionInfo("hostName", "userName", privateKeyAuthenticationMethod);
+var sftpClient = new SftpClient(sftpConnectionInfo);
+
+var adapters = new List<IAdapter>
+{
+    new LocalAdapter("local", "/var/files"),
+    new SftpAdapter("sftp", "/var/files", sftpClient)
+};
+
+var fileSystem = new FileSystem(adapters);
+```
diff --git a/README.md b/README.md
