Skip to content

Commit

Permalink
Update badges, monogram, and grammar
Browse files Browse the repository at this point in the history
  • Loading branch information
maxrjones committed Jan 10, 2024
1 parent 988aecf commit 12f07e9
Showing 1 changed file with 12 additions and 26 deletions.
38 changes: 12 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,19 @@
<p align='left'>
<a href='https://carbonplan.org/#gh-light-mode-only'>
<img
src='https://carbonplan-assets.s3.amazonaws.com/monogram/dark-small.png'
height='48px'
/>
</a>
<a href='https://carbonplan.org/#gh-dark-mode-only'>
<img
src='https://carbonplan-assets.s3.amazonaws.com/monogram/light-small.png'
height='48px'
/>
</a>
<p align="left" >
<a href='https://carbonplan.org'>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://carbonplan-assets.s3.amazonaws.com/monogram/light-small.png">
<img alt="CarbonPlan monogram." height="48" src="https://carbonplan-assets.s3.amazonaws.com/monogram/dark-small.png">
</picture>
</a>
</p>

# carbonplan / components

**shared react components for our websites**

[![GitHub][github-badge]][github]
[![Build Status]][actions]
![MIT License][]
![NPM Version][]

[github]: https://github.com/carbonplan/components
[github-badge]: https://badgen.net/badge/-/github?icon=github&label
[build status]: https://github.com/carbonplan/components/actions/workflows/main.yml/badge.svg
[actions]: https://github.com/carbonplan/components/actions/workflows/main.yml
[mit license]: https://badgen.net/badge/license/MIT/blue
[npm version]: https://img.shields.io/npm/v/@carbonplan/components
[![CI](https://github.com/carbonplan/components/actions/workflows/main.yml/badge.svg)](https://github.com/carbonplan/components/actions/workflows/main.yml)
![NPM Version](https://img.shields.io/npm/v/@carbonplan/components)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

These are a set of modular but opinionated [`react`](https://github.com/facebook/react) components. They assume and make extensive use of [`theme-ui`](https://github.com/system-ui/theme-ui) and [`next`](https://github.com/vercel/next.js), and are meant to be composed with our [`theme`](https://github.com/carbonplan/theme). The main use cases are to encourage consistency throughout our design and streamline building our own websites by reducing boilerplate. However, over time we might expand them to enable easier embedding of our content into other websites.

Expand Down Expand Up @@ -101,8 +87,8 @@ To update a component and publish a new version, first make your changes, then f

## license

All the code in this repository is [MIT](https://choosealicense.com/licenses/mit/) licensed, but we request that you please provide attribution if reusing any of our digital content (graphics, logo, articles, etc.).
All the code in this repository is [MIT](https://choosealicense.com/licenses/mit/)-licensed, but we request that you please provide attribution if reusing any of our digital content (graphics, logo, articles, etc.).

## about us

CarbonPlan is a non-profit organization that uses data and science for climate action. We aim to improve the transparency and scientific integrity of carbon removal and climate solutions through open data and tools. Find out more at [carbonplan.org](https://carbonplan.org/) or get in touch by [opening an issue](https://github.com/carbonplan/components/issues/new) or [sending us an email](mailto:hello@carbonplan.org).
CarbonPlan is a nonprofit organization that uses data and science for climate action. We aim to improve the transparency and scientific integrity of carbon removal and climate solutions through open data and tools. Find out more at [carbonplan.org](https://carbonplan.org/) or get in touch by [opening an issue](https://github.com/carbonplan/components/issues/new) or [sending us an email](mailto:hello@carbonplan.org).

0 comments on commit 12f07e9

Please sign in to comment.