Merge pull request #4 from rickbutterfield/chore/READMEs

chore: READMEs

Author: rickbutterfield

.github/CONTRIBUTING.md

@@ -2,6 +2,15 @@
 
 Contributions to this package are most welcome! 
 
-There is a test site in the solution to make working with this repository easier.
+To raise a new bug, create an issue on the GitHub repository. To fix a bug or add new features, fork the repository and send a pull request with your changes. Feel free to add ideas to the repository's issues list if you would to discuss anything related to the library.
 
-TODO: *instructions on how to log in to test site assuming you have committed a db with some content*
+### Using the test sites
+The repo comes with test sites for Umbraco 10, 11, 12 and 13. Use the following credentials to log into the back office:
+
+```
+Username: [email protected]
+Password: 1234567890
+```
+
+### Who do I talk to?
+This project is maintained by [Rick Butterfield](https://github.com/rickbutterfield), [Thomas Morris](https://github.com/tcmorris) and contributors. If you have any questions about the project please get in touch on [Twitter](https://twitter.com/rickbutterfield), or by raising an issue on GitHub.

.github/README.md

@@ -4,28 +4,35 @@
 [![NuGet](https://img.shields.io/nuget/vpre/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)
 
-TODO: describe your package
+A community 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.
 
-<!--
-Including screenshots is a really good idea! 
+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.
 
-If you put images into /docs/screenshots, then you would reference them in this readme as, for example:
-
-<img alt="..." src="https://github.com/rickbutterfield/Umbraco.Community.Sustainability/blob/develop/docs/screenshots/screenshot.png">
--->
+<img src="https://raw.githubusercontent.com/rickbutterfield/Umbraco.Community.Sustainability/main/.github/assets/sustainability-contentapp-2.jpeg" alt="Umbraco.Community.Sustainability content app" />
 
 ## Installation
 
 Add the package to an existing Umbraco website (v10.4+) from nuget:
 
 `dotnet add package Umbraco.Community.Sustainability`
 
-TODO *provide any other instructions for someone using your package*
+Once added, a new Content App will be available alongside your Umbraco pages allowing you to trigger a sustainability report.
 
 ## Contributing
 
-Contributions to this package are most welcome! Please read the [Contributing Guidelines](CONTRIBUTING.md).
+Contributions to this package are most welcome! Please read the [Contributing Guidelines](CONTRIBUTING.md) for how to get involved.
+
+Here are some things for our roadmap:
+
+- A visual review of the content app (particularly with v14/Belissima in mind)
+- Dashboard
+- Health checks
+- Content and media warnings
+- Configuration options
+- Improved accuracy of reporting
+
+## License
 
-## Acknowledgments
+Copyright &copy; [Rick Butterfield](https://github.com/rickbutterfield), [Thomas Morris](https://github.com/tcmorris) and other contributors.
 
-TODO
+Licensed under the [MIT License](https://github.com/rickbutterfield/Umbraco.Community.Sustainability/blob/main/LICENSE.md).

.github/assets/sustainability-contentapp-1.jpeg

@@ -4,4 +4,22 @@
 [![NuGet](https://img.shields.io/nuget/vpre/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)](https://github.com/rickbutterfield/Umbraco.Community.Sustainability/blob/main/LICENSE)
 
-TODO: describe your package for nuget audience
+A community 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.
+
+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.
+
+<img src="https://raw.githubusercontent.com/rickbutterfield/Umbraco.Community.Sustainability/main/.github/assets/sustainability-contentapp-2.jpeg" alt="Umbraco.Community.Sustainability content app" />
+
+## Installation
+
+Add the package to an existing Umbraco website (v10.4+) from nuget:
+
+`dotnet add package Umbraco.Community.Sustainability`
+
+Once added, a new Content App will be available alongside your Umbraco pages allowing you to trigger a sustainability report.
+
+## License
+
+Copyright &copy; [Rick Butterfield](https://github.com/rickbutterfield), [Thomas Morris](https://github.com/tcmorris) and other contributors.
+
+Licensed under the [MIT License](https://github.com/rickbutterfield/Umbraco.Community.Sustainability/blob/main/LICENSE.md).

.github/assets/sustainability-contentapp-2.jpeg

@@ -5,6 +5,7 @@ VisualStudioVersion = 17.4.33020.496
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{F2202CE0-0485-4493-A256-F2E7B2DCB32D}"
 	ProjectSection(SolutionItems) = preProject
+		..\.github\CONTRIBUTING.md = ..\.github\CONTRIBUTING.md
 		..\LICENSE = ..\LICENSE
 		..\.github\README.md = ..\.github\README.md
 		..\umbraco-marketplace.json = ..\umbraco-marketplace.json

docs/README_nuget.md

@@ -8,7 +8,7 @@
     <Product>Umbraco.Community.Sustainability</Product>
     <PackageId>Umbraco.Community.Sustainability</PackageId>
     <Title>Umbraco.Community.Sustainability</Title>
-    <Description>...</Description>
+    <Description>A package from the Umbraco Community Sustainability Team which helps developers and editors see and improve the carbon impact of their websites.</Description>
     <PackageTags>umbraco;umbraco-marketplace</PackageTags>
     <RootNamespace>Umbraco.Community.Sustainability</RootNamespace>
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>

src/Umbraco.Community.Sustainability.sln

@@ -1,14 +1,37 @@
 {
-    "$schema": "https://marketplace.umbraco.com/umbraco-marketplace-schema.json", 
-    "AuthorDetails": {
-      "Name": "Umbraco Sustainability Community Team",
-      "ImageUrl": "https://github.com/rickbutterfield.png"
+  "$schema": "https://marketplace.umbraco.com/umbraco-marketplace-schema.json",
+  "AuthorDetails": {
+    "Name": "Umbraco Sustainability Community Team",
+    "ImageUrl": "https://github.com/rickbutterfield.png",
+    "Contributors": [
+      {
+        "Name": "Rick Butterfield",
+        "Url": "https://github.com/rickbutterfield"
+      },
+      {
+        "Name": "Thomas Morris",
+        "Url": "http://github.com/tcmorris"
+      }
+    ]
+  },
+  "Category": "Editor Tools",
+  "Description": "A package from the Umbraco Community Sustainability Team which helps developers and editors see and improve the carbon impact of their websites.",
+  "LicenseTypes": [ "Free" ],
+  "IssueTrackerUrl": "https://github.com/rickbutterfield/Umbraco.Community.Sustainability/issues",
+  "PackageType": "Package",
+  "Screenshots": [
+    {
+      "ImageUrl": "https://raw.githubusercontent.com/rickbutterfield/Umbraco.Community.Sustainability/main/.github/assets/sustainability-contentapp-1.jpeg",
+      "Caption": "Content app for Sustainability - running a report"
     },
-    "Category": "",
-    "Description": "",
-    "LicenseTypes": [ "Free" ],
-    "IssueTrackerUrl": "https://github.com/rickbutterfield/Umbraco.Community.Sustainability/issues",
-    "PackageType": "Package",
-    "Tags": [],
-    "Title": "Umbraco.Community.Sustainability"
-  }
+    {
+      "ImageUrl": "https://raw.githubusercontent.com/rickbutterfield/Umbraco.Community.Sustainability/main/.github/assets/sustainability-contentapp-2.jpeg",
+      "Caption": "Content app for Sustainability - view detailed report"
+    }
+  ],
+  "Tags": [
+    "backoffice",
+    "sustainability"
+  ],
+  "Title": "Umbraco.Community.Sustainability"
+}