Skip to content

Commit 95dfa45

Browse files
committed
Nuget and marketplace info
1 parent e5430f7 commit 95dfa45

File tree

2 files changed

+44
-13
lines changed

2 files changed

+44
-13
lines changed

docs/README_nuget.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,22 @@
44
[![NuGet](https://img.shields.io/nuget/vpre/Umbraco.Community.Sustainability?color=0273B3)](https://www.nuget.org/packages/Umbraco.Community.Sustainability)
55
[![GitHub license](https://img.shields.io/github/license/rickbutterfield/Umbraco.Community.Sustainability?color=8AB803)](https://github.com/rickbutterfield/Umbraco.Community.Sustainability/blob/main/LICENSE)
66

7-
TODO: describe your package for nuget audience
7+
A community package from the [Umbraco sustainability team](https://umbraco.com/blog/meet-the-new-community-sustainability-team/), which helps developers and editors see and improve the carbon impact of their websites.
8+
9+
In the backoffice, there is a content app to see page weight and carbon emissions, which is then converted to a carbon rating for individual pages.
10+
11+
<img src="https://raw.githubusercontent.com/rickbutterfield/Umbraco.Community.Sustainability/main/.github/assets/sustainability-contentapp-2.jpeg" alt="Umbraco.Community.Sustainability content app" />
12+
13+
## Installation
14+
15+
Add the package to an existing Umbraco website (v10.4+) from nuget:
16+
17+
`dotnet add package Umbraco.Community.Sustainability`
18+
19+
Once added, a new content app will be available alongside your Umbraco pages allowing you to trigger a sustainability report.
20+
21+
## License
22+
23+
Copyright &copy; [Rick Butterfield](https://rickbutterfield.dev), and other contributors.
24+
25+
Licensed under the [MIT License](https://github.com/rickbutterfield/Umbraco.Community.Sustainability/blob/main/LICENSE.md).

umbraco-marketplace.json

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,27 @@
11
{
2-
"$schema": "https://marketplace.umbraco.com/umbraco-marketplace-schema.json",
3-
"AuthorDetails": {
4-
"Name": "Umbraco Sustainability Community Team",
5-
"ImageUrl": "https://github.com/rickbutterfield.png"
2+
"$schema": "https://marketplace.umbraco.com/umbraco-marketplace-schema.json",
3+
"AuthorDetails": {
4+
"Name": "Umbraco Sustainability Community Team",
5+
"ImageUrl": "https://github.com/rickbutterfield.png"
6+
},
7+
"Category": "Editor Tools",
8+
"Description": "Sustainability extensions for Umbraco.",
9+
"LicenseTypes": [ "Free" ],
10+
"IssueTrackerUrl": "https://github.com/rickbutterfield/Umbraco.Community.Sustainability/issues",
11+
"PackageType": "Package",
12+
"Screenshots": [
13+
{
14+
"ImageUrl": "https://raw.githubusercontent.com/rickbutterfield/Umbraco.Community.Sustainability/main/.github/assets/sustainability-contentapp-1.jpeg",
15+
"Caption": "Content app for Sustainability - running a report"
616
},
7-
"Category": "",
8-
"Description": "",
9-
"LicenseTypes": [ "Free" ],
10-
"IssueTrackerUrl": "https://github.com/rickbutterfield/Umbraco.Community.Sustainability/issues",
11-
"PackageType": "Package",
12-
"Tags": [],
13-
"Title": "Umbraco.Community.Sustainability"
14-
}
17+
{
18+
"ImageUrl": "https://raw.githubusercontent.com/rickbutterfield/Umbraco.Community.Sustainability/main/.github/assets/sustainability-contentapp-2.jpeg",
19+
"Caption": "Content app for Sustainability - view detailed report"
20+
}
21+
],
22+
"Tags": [
23+
"backoffice",
24+
"sustainability"
25+
],
26+
"Title": "Umbraco.Community.Sustainability"
27+
}

0 commit comments

Comments
 (0)