Skip to content
This repository has been archived by the owner on Jul 12, 2019. It is now read-only.

Commit

Permalink
feat(project): release v10 (#455)
Browse files Browse the repository at this point in the history
* docs(readme): update README for v10

* docs(readme): update list to table

* docs(readme): update README to include developer guide

* Update README.md
  • Loading branch information
joshblack authored Mar 29, 2019
1 parent 360c9eb commit 2485bd7
Showing 1 changed file with 29 additions and 9 deletions.
38 changes: 29 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,40 @@
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)
[![PRs welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](./.github/CONTRIBUTING.md)

> **[Experimental]** The Carbon elements project helps developers execute the
> The Carbon elements project helps developers execute the
> IBM Design Language in digital and software products. This project contains a
> collection of packages for different elements of this language. We'll be
> introducing additional elements over the next several months.
## About
## Getting started

The `carbon-elements` package is currently an experimental effort from the
Carbon Design System. All work in this project represents pre-release work and is
not intended for production.
Carbon elements is a collection of packages that enable developers to use the
IBM Design Language in code. We current offer the following packages that you
can start using today:

| Package name | Description |
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`@carbon/colors`](./packages/colors) | Working with colors like Blue 50 |
| [`@carbon/grid`](./packages/grid) | Building layouts using the new 16 column grid system |
| [`@carbon/icons`](./packages/icons) | Iconography assets. We also offer support in: [React](./packages/icons-react), [Angular](./packages/icons-angular), and [Vue](./packages/icons-vue) |
| [`@carbon/layout`](./packages/layout) | Layout-based units and spacing scale |
| [`@carbon/motion`](./packages/motion) | Productive and expressive motion curves |
| [`@carbon/themes`](./packages/themes) | Color tokens available in the Carbon Design System, like `$interactive-01` |
| [`@carbon/type`](./packages/type) | New type tokens used alongside IBM Plex |

While you can use each package individually if you would like, we also offer a
bundled version of these packages in [`@carbon/elements`](./packages/elements).

## 🙌 Contributing

We're always looking for contributors to help us fix bugs, build new
features, or help us improve the project documentation. If you're
interested, definitely check out our [Contributing Guide](/.github/CONTRIBUTING.md)
and our [Developer Guide](./github/developing.md)! 👀

## 📝 License

Licensed under the [Apache 2.0 License](/LICENSE).

## Contributors

Expand All @@ -24,7 +48,3 @@ possible without the incredible work done by the following individuals:
Mike Abbink, In-Hee Bae, Sadek Bazaraa, Chiu-Ping Chiu, Conrad Ennis,
Peter Garvin, Hayley Hughes, Ryan Mellody, Erica Raymond, Denise Shaw, Wonil Suh,
and Shixie Trofimov.

## 🤲 Contributing

To learn more about how to contribute, look [here](/.github/CONTRIBUTING.md)!

0 comments on commit 2485bd7

Please sign in to comment.