Skip to content

Commit f08c293

Browse files
committed
doc: Update NuGet README
1 parent b0e7ceb commit f08c293

1 file changed

Lines changed: 7 additions & 42 deletions

File tree

docs/README_nuget.md

Lines changed: 7 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Umbraco.Community.FileSystemProviders.B2
1+
# B2 Media File System Provider
22

33
[![Documentation](https://img.shields.io/badge/Documentation-123?color=394933&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgZmlsbD0iY3VycmVudENvbG9yIiBjb2xvcj0id2hpdGUiIGNsYXNzPSJiaSBiaS1ib29rIiB2aWV3Qm94PSIwIDAgMTYgMTYiPgogIDxwYXRoIGQ9Ik0xIDIuODI4Yy44ODUtLjM3IDIuMTU0LS43NjkgMy4zODgtLjg5MyAxLjMzLS4xMzQgMi40NTguMDYzIDMuMTEyLjc1MnY5Ljc0NmMtLjkzNS0uNTMtMi4xMi0uNjAzLTMuMjEzLS40OTMtMS4xOC4xMi0yLjM3LjQ2MS0zLjI4Ny44MTF6bTcuNS0uMTQxYy42NTQtLjY4OSAxLjc4Mi0uODg2IDMuMTEyLS43NTIgMS4yMzQuMTI0IDIuNTAzLjUyMyAzLjM4OC44OTN2OS45MjNjLS45MTgtLjM1LTIuMTA3LS42OTItMy4yODctLjgxLTEuMDk0LS4xMTEtMi4yNzgtLjAzOS0zLjIxMy40OTJ6TTggMS43ODNDNy4wMTUuOTM2IDUuNTg3LjgxIDQuMjg3Ljk0Yy0xLjUxNC4xNTMtMy4wNDIuNjcyLTMuOTk0IDEuMTA1QS41LjUgMCAwIDAgMCAyLjV2MTFhLjUuNSAwIDAgMCAuNzA3LjQ1NWMuODgyLS40IDIuMzAzLS44ODEgMy42OC0xLjAyIDEuNDA5LS4xNDIgMi41OS4wODcgMy4yMjMuODc3YS41LjUgMCAwIDAgLjc4IDBjLjYzMy0uNzkgMS44MTQtMS4wMTkgMy4yMjItLjg3NyAxLjM3OC4xMzkgMi44LjYyIDMuNjgxIDEuMDJBLjUuNSAwIDAgMCAxNiAxMy41di0xMWEuNS41IDAgMCAwLS4yOTMtLjQ1NWMtLjk1Mi0uNDMzLTIuNDgtLjk1Mi0zLjk5NC0xLjEwNUMxMC40MTMuODA5IDguOTg1LjkzNiA4IDEuNzgzIi8+Cjwvc3ZnPg==)](https://docs.jcdc.dev/umbraco-community-filesystemproviders-b2/latest)
44
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco%20Marketplace-%23f5c1bc?logo=umbraco&logoColor=162335)](https://marketplace.umbraco.com/package/Umbraco.Community.FileSystemProviders.B2)
@@ -13,53 +13,18 @@ An implementation of the Umbraco IFileSystem connecting your Umbraco Media secti
1313

1414
The package includes a suite of health checks to verify the connection to the B2 bucket.
1515

16-
## Installation
16+
## Security
1717

18-
### Install Package
19-
20-
```powershell
21-
dotnet add package Umbraco.Community.FileSystemProviders.B2
22-
```
23-
24-
## Quick Start
25-
26-
### Prerequisites
27-
28-
1. A BackBlaze B2 account
29-
2. A bucket created in your BackBlaze B2 account
30-
3. An [application key](https://www.backblaze.com/docs/cloud-storage-create-and-manage-app-keys)
31-
- Take note of the `KeyId` and `ApplicationKey`
32-
4. An Endpoint URL `s3.<region>.backblazeb2.com` (e.g. `s3.us-west-004.backblazeb2.com`)
33-
34-
## Configuration
35-
36-
1. Add the following configuration to your `appsettings.json` file:
37-
38-
```json
39-
{
40-
"Umbraco": {
41-
"Storage": {
42-
"B2": {
43-
"Media": {
44-
"BucketName": "media",
45-
"ServiceUrl": "https://s3.<region>.backblazeb2.com",
46-
"UseAccelerateEndpoint": false,
47-
"Credentials": {
48-
"ApplicationKey": "abc123abc123abc123abc123abc123",
49-
"KeyId": "aaaabbbbccccdddd0000000001"
50-
}
51-
}
52-
}
53-
}
54-
}
55-
}
56-
```
18+
This project takes security and support seriously.
19+
Please visit the [Security](https://github.com/jcdcdev/Umbraco.Community.FileSystemProviders.B2?tab=security-ov-file) page for more information.
5720

5821
## Contributing
5922

6023
Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.FileSystemProviders.B2/contribute) page.
6124

62-
## Acknowledgements (Thanks)
25+
## Acknowledgements
26+
27+
Thank you to the following projects and individuals for their contributions. High five, you rock! 🤘🦄
6328

6429
- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)
6530
- adam-werner - [Our.Umbraco.StorageProviders.AWSS3](https://github.com/adam-werner/Our.Umbraco.StorageProviders.AWSS3)

0 commit comments

Comments
 (0)