Skip to content

Commit 4f8e923

Browse files
committed
doc: Update NuGet README
1 parent a05ad3d commit 4f8e923

File tree

1 file changed

+65
-40
lines changed

1 file changed

+65
-40
lines changed

docs/README_nuget.md

Lines changed: 65 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,65 @@
1-
<!doctype html>
2-
<html lang="en" class="h-100">
3-
4-
<head>
5-
<meta charset="utf-8">
6-
<meta name="viewport" content="width=device-width, initial-scale=1">
7-
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css" rel="stylesheet"
8-
integrity="sha384-T3c6CoIi6uLrA9TneNEoa7RxnatzjcDSCmG1MXxSR1GAsXEV/Dwwykc2MPK8M2HN" crossorigin="anonymous">
9-
<title>404</title>
10-
</head>
11-
12-
<body class="h-100">
13-
<div class="d-flex align-items-center justify-content-center h-100">
14-
<div class="">
15-
<h1>404 Not Found</h1>
16-
<p> Sorry, the page you are looking for could not be found.</p>
17-
</div>
18-
</div>
19-
20-
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-C6RzsynM9kWDrMNeT87bh95OGNyZPhcTNXj1NW7RuBCsyN/o0jlpcV8Qyq46cDfL" crossorigin="anonymous" type="8184725a7d8faa1b3060d931-text/javascript"></script>
21-
<script type="8184725a7d8faa1b3060d931-text/javascript">
22-
const darkModeMediaQuery = window.matchMedia('(prefers-color-scheme: dark)');
23-
24-
if (darkModeMediaQuery.matches) {
25-
document.documentElement.setAttribute('data-bs-theme', 'dark');
26-
} else {
27-
document.documentElement.setAttribute('data-bs-theme', 'light');
28-
}
29-
30-
darkModeMediaQuery.addEventListener('change', (event) => {
31-
if (event.matches) {
32-
document.documentElement.setAttribute('data-bs-theme', 'dark');
33-
} else {
34-
document.documentElement.setAttribute('data-bs-theme', 'light');
35-
}
36-
});
37-
</script>
38-
<script src="/cdn-cgi/scripts/7d0fa10a/cloudflare-static/rocket-loader.min.js" data-cf-settings="8184725a7d8faa1b3060d931-|49" defer></script></body>
39-
40-
</html>
1+
# Umbraco.Community.FileSystemProviders.B2
2+
3+
[![Documentation](https://img.shields.io/badge/Docs-Quickstart-394933?style=flat&logo=github)](https://github.com/jcdcdev/Umbraco.Community.FileSystemProviders.B2/#quick-start)
4+
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/Umbraco.Community.FileSystemProviders.B2)
5+
[![License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.FileSystemProviders.B2?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.FileSystemProviders.B2?tab=MIT-1-ov-file)
6+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.FileSystemProviders.B2?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.FileSystemProviders.B2)
7+
[![Project Website](https://img.shields.io/badge/Project%20Website-jcdc.dev-jcdcdev?style=flat&color=3c4834&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgZmlsbD0id2hpdGUiIGNsYXNzPSJiaSBiaS1wYy1kaXNwbGF5IiB2aWV3Qm94PSIwIDAgMTYgMTYiPgogIDxwYXRoIGQ9Ik04IDFhMSAxIDAgMCAxIDEtMWg2YTEgMSAwIDAgMSAxIDF2MTRhMSAxIDAgMCAxLTEgMUg5YTEgMSAwIDAgMS0xLTF6bTEgMTMuNWEuNS41IDAgMSAwIDEgMCAuNS41IDAgMCAwLTEgMG0yIDBhLjUuNSAwIDEgMCAxIDAgLjUuNSAwIDAgMC0xIDBNOS41IDFhLjUuNSAwIDAgMCAwIDFoNWEuNS41IDAgMCAwIDAtMXpNOSAzLjVhLjUuNSAwIDAgMCAuNS41aDVhLjUuNSAwIDAgMCAwLTFoLTVhLjUuNSAwIDAgMC0uNS41TTEuNSAyQTEuNSAxLjUgMCAwIDAgMCAzLjV2N0ExLjUgMS41IDAgMCAwIDEuNSAxMkg2djJoLS41YS41LjUgMCAwIDAgMCAxSDd2LTRIMS41YS41LjUgMCAwIDEtLjUtLjV2LTdhLjUuNSAwIDAgMSAuNS0uNUg3VjJ6Ii8+Cjwvc3ZnPg==)](https://jcdc.dev/umbraco-packages/b2-media-file-system-provider)
8+
9+
10+
An implementation of the Umbraco IFileSystem connecting your Umbraco Media section to a [BackBlaze B2 Storage account](https://www.backblaze.com/cloud-storage).
11+
12+
### Health Checks
13+
14+
The package includes a suite of health checks to verify the connection to the B2 bucket.
15+
16+
## Quick Start
17+
18+
### Prerequisites
19+
20+
1. A BackBlaze B2 account
21+
2. A bucket created in your BackBlaze B2 account
22+
3. An [application key](https://www.backblaze.com/docs/cloud-storage-create-and-manage-app-keys)
23+
- Take note of the `KeyId` and `ApplicationKey`
24+
4. An Endpoint URL `s3.<region>.backblazeb2.com` (e.g. `s3.us-west-004.backblazeb2.com`)
25+
26+
```
27+
dotnet add package Umbraco.Community.FileSystemProviders.B2
28+
```
29+
30+
## Configuration
31+
32+
1. Add the following configuration to your `appsettings.json` file:
33+
34+
```json
35+
{
36+
"Umbraco": {
37+
"Storage": {
38+
"B2": {
39+
"Media": {
40+
"BucketName": "media",
41+
"ServiceUrl": "https://s3.<region>.backblazeb2.com",
42+
"UseAccelerateEndpoint": false,
43+
"Credentials": {
44+
"ApplicationKey": "abc123abc123abc123abc123abc123",
45+
"KeyId": "aaaabbbbccccdddd0000000001"
46+
}
47+
}
48+
}
49+
}
50+
}
51+
}
52+
```
53+
54+
## Contributing
55+
56+
Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.FileSystemProviders.B2/contribute) page.
57+
58+
## Acknowledgements (Thanks)
59+
60+
- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)
61+
- adam-werner - [Our.Umbraco.StorageProviders.AWSS3](https://github.com/adam-werner/Our.Umbraco.StorageProviders.AWSS3)
62+
- jcdcdev - [jcdcdev.Umbraco.PackageTemplate](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate)
63+
64+
65+

0 commit comments

Comments
 (0)