Skip to content

Commit 6071a96

Browse files
committed
Adjusting descriptions
1 parent 318a399 commit 6071a96

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# This package for laravel calculates Co2 emission for data
1+
# Package for Laravel calculating Co2 emission based on Sustainable Web Design (SWD) model
22

33
[![Latest Version on Packagist](https://img.shields.io/packagist/v/ahoicloud/co2.svg?style=flat-square)](https://packagist.org/packages/ahoicloud/co2)
44
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/ahoicloud/co2/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/ahoicloud/co2/actions?query=workflow%3Arun-tests+branch%3Amain)
@@ -9,10 +9,11 @@ Every byte of data that’s uploaded or downloaded produces CO2. By being able t
99
+ Create a carbon budget for your site
1010
+ Inform the user when they uploading or downloading carbon intensive files
1111

12+
The package uses the [Sustainable Web Design (SWD)](https://sustainablewebdesign.org/calculating-digital-emissions) model.
13+
The yearly average grid intensity data comes from [Ember](https://ember-climate.org/data/data-explorer/), as well as marginal intensity data from the [UNFCCC](https://unfccc.int/) (United Nations Framework Convention on Climate Change).
1214

13-
The package uses the yearly average grid intensity data from [Ember](https://ember-climate.org/data/data-explorer/), as well as marginal intensity data from the [UNFCCC](https://unfccc.int/) (United Nations Framework Convention on Climate Change).
1415

15-
The package is build for Laravel and heavy inspired by [thegreenwebfoundation/co2.js](https://github.com/thegreenwebfoundation/co2.js)
16+
The package is build for [Laravel](https://github.com/laravel/framework) and is based on the great work done by [The Green Web Foundation](https://thegreenwebfoundation.org) in the [CO2.js](https://github.com/thegreenwebfoundation/co2.js) package.
1617

1718

1819

@@ -24,6 +25,8 @@ You can install the package via composer:
2425
composer require ahoicloud/co2
2526
```
2627

28+
### Optional
29+
2730
You can publish the config file with:
2831

2932
```bash

composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ahoicloud/co2",
3-
"description": "This packge calculates co2 per byte",
3+
"description": "Package for laravel calculating Co2 emission based on Sustainable Web Design (SWD) model",
44
"keywords": [
55
"ahoicloud",
66
"laravel",

0 commit comments

Comments
 (0)