Skip to content

Commit ced6f95

Browse files
committed
doc: Update ./.github/README.md
1 parent 96332e5 commit ced6f95

File tree

1 file changed

+25
-35
lines changed

1 file changed

+25
-35
lines changed

.github/README.md

Lines changed: 25 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
# Umbraco.Community.BackOfficeOrganiser
22

3-
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/umbraco.community.backofficeorganiser)
4-
[![GitHub License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.BackOfficeOrganiser?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/blob/main/LICENSE)
5-
[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.BackOfficeOrganiser?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.BackOfficeOrganiser/)
3+
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/Umbraco.Community.BackOfficeOrganiser)
4+
[![License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.BackOfficeOrganiser?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser?tab=MIT-1-ov-file)
5+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.BackOfficeOrganiser?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.BackOfficeOrganiser)
66
[![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/back-office-organiser)
77

8-
Is your backoffice a bit untidy?
98

10-
- Single-click (and opinionated) organiser for
11-
- Document Types
12-
- Media Types
13-
- Member Types
14-
- Data Types
15-
- Automatically sorts on save (configurable)
9+
Is your Backoffice a bit untidy?
1610

17-
![A screenshot of the Back Office Organiser in action](https://raw.githubusercontent.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/main/docs/screenshots/backoffice.png)
11+
- Single-click (and opinionated) organiser for
12+
- Document Types
13+
- Media Types
14+
- Member Types
15+
- Data Types
1816

1917
## Quick Start
2018

@@ -26,28 +24,17 @@ Is your backoffice a bit untidy?
2624
- Refresh your page and enjoy a cleaner backoffice ✨
2725

2826
## Configuration
27+
2928
Add the following to your `appsettings.json` file
3029

31-
```JSON
32-
{
33-
"BackOfficeOrganiser": {
34-
"DataTypes": {
35-
"InternalFolderName": "Internal",
36-
"ThirdPartyFolderName": "Third Party",
37-
"CustomFolderName": "Custom",
38-
"OrganiseOnSave": true
39-
},
40-
"ContentTypes": {
41-
"OrganiseOnSave": true
42-
},
43-
"MediaTypes": {
44-
"OrganiseOnSave": true
45-
},
46-
"MemberTypes": {
47-
"OrganiseOnSave": true
48-
}
49-
}
50-
}
30+
```json title="appsettings.json"
31+
"BackOfficeOrganiser": {
32+
"DataTypes": {
33+
"InternalFolderName": "Internal",
34+
"ThirdPartyFolderName": "Third Party",
35+
"CustomFolderName": "Custom"
36+
}
37+
}
5138
```
5239

5340
## Extending
@@ -60,7 +47,7 @@ You can implement your own `Organise Action`, a method that determines where a t
6047
- `Data Types` => `IDataTypeOrganiseAction`
6148

6249
### Example
63-
```csharp
50+
```csharp title="ExampleContentTypeOrganiseAction.cs"
6451
using jcdcdev.Umbraco.Core.Extensions;
6552
using Umbraco.Cms.Core.Models;
6653
using Umbraco.Cms.Core.Services;
@@ -112,8 +99,11 @@ public class Composer : IComposer
11299

113100
## Contributing
114101

115-
Contributions to this package are most welcome! Please read the [Contributing Guidelines](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/blob/main/.github/CONTRIBUTING.md).
102+
Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/contribute) page.
103+
104+
## Acknowledgements (Thanks)
105+
106+
- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)
107+
116108

117-
## Acknowledgments (thanks!)
118109

119-
- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)

0 commit comments

Comments
 (0)