Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Rick Butterfield committed Jun 4, 2024
2 parents 3897b26 + 60dd43a commit e2e882a
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 4 deletions.
26 changes: 24 additions & 2 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,33 @@
# Umbraco.Community.Sustainability

[![Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.Sustainability?color=cc9900)](https://www.nuget.org/packages/Umbraco.Community.Sustainability/)
[![NuGet](https://img.shields.io/nuget/vpre/Umbraco.Community.Sustainability?color=0273B3)](https://www.nuget.org/packages/Umbraco.Community.Sustainability)
[![NuGet](https://img.shields.io/nuget/v/Umbraco.Community.Sustainability?color=0273B3)](https://www.nuget.org/packages/Umbraco.Community.Sustainability)
[![GitHub license](https://img.shields.io/github/license/rickbutterfield/Umbraco.Community.Sustainability?color=8AB803)](../LICENSE)

A package from the [Umbraco Community 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.

## Installation
> [!IMPORTANT]
> **v2.x** supports Umbraco v14.x
>
> **v1.x** supports Umbraco v10.8.x - v13.x
>
> To understand more about which Umbraco CMS versions are actively supported by Umbraco HQ, please see [Umbraco's Long-term Support (LTS) and End-of-Life (EOL) policy](https://umbraco.com/products/knowledge-center/long-term-support-and-end-of-life/).
This package is [available via NuGet](https://www.nuget.org/packages/Umbraco.Community.Sustainability).

To install the package, you can use either the .NET CLI:

```
dotnet add package Umbraco.Community.Sustainability
```

or the NuGet Package Manager:

```
Install-Package Umbraco.Community.Sustainability
```

## Features
Once installed, two new features are enabled:

Expand All @@ -21,7 +43,7 @@ On each content page, a Content App is added which allows users to see and bench

## Installation

Add the package to an existing Umbraco website (v10.8.0+) from nuget:
Add the package to an existing Umbraco website from nuget:

`dotnet add package Umbraco.Community.Sustainability`

Expand Down
10 changes: 8 additions & 2 deletions docs/README_nuget.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,14 @@ On each content page, a Content App is added which allows users to see and bench
![Umbraco.Community.Sustainability content app](https://raw.githubusercontent.com/rickbutterfield/Umbraco.Community.Sustainability/main/.github/assets/sustainability-contentapp-2.jpeg)

## Installation

Add the package to an existing Umbraco website (v10.8.0+) from nuget:
> [!IMPORTANT]
> **v2.x** supports Umbraco v14.x
>
> **v1.x** supports Umbraco v10.8.x - v13.x
>
> To understand more about which Umbraco CMS versions are actively supported by Umbraco HQ, please see [Umbraco's Long-term Support (LTS) and End-of-Life (EOL) policy](https://umbraco.com/products/knowledge-center/long-term-support-and-end-of-life/).
Add the package to an existing Umbraco website from NuGet:

`dotnet add package Umbraco.Community.Sustainability`

Expand Down

0 comments on commit e2e882a

Please sign in to comment.