README.md

# 🎨 Cunningham, the best OpenSource Design System

[![CircleCI](https://circleci.com/gh/openfun/cunningham/tree/master.svg?style=svg)](https://circleci.com/gh/openfun/richie/tree/master)

<p align="center">
    <a href="https://openfun.github.io/cunningham"><b>📚&nbsp;&nbsp;Documentation</b></a> •
    <a href="https://www.figma.com/file/sSEMhow3g5zpEkyDLEQ1ZO/DS-Cunningham?node-id=47%3A261&t=nKRnadK4sslyVxD7-0"><b>🖌️&nbsp;&nbsp;Figma</b></a>
</p>

## Getting started

Everything is detailed on our [documentation](https://openfun.github.io/cunningham). 📚

## Contributing

Please see our [contributing guidelines](./CONTRIBUTING.md).

## License

This work is released under the MIT License (see [LICENSE](./LICENSE)).
📝(doc) update docs to install published packages + contributing guide Updated various parts of existing documentations to make a clean path to learn how to install the library. I let the most complicated part in the tokens's README.md file, which is referenced from the Storybook. 2023-01-30 15:00:46 +01:00			`# 🎨 Cunningham, the best OpenSource Design System`
🔧(global) setup Turborepo and package.json Add configuration files to make use of Turborepo. Setup constraints values for package.json regarding node and package manager. 2022-12-01 12:01:10 +01:00
📝(global) add README.md Create a first version of README.md 2022-12-01 14:50:15 +01:00			`[![CircleCI](https://circleci.com/gh/openfun/cunningham/tree/master.svg?style=svg)](https://circleci.com/gh/openfun/richie/tree/master)`
🔧(global) setup Turborepo and package.json Add configuration files to make use of Turborepo. Setup constraints values for package.json regarding node and package manager. 2022-12-01 12:01:10 +01:00
📝(readme) update readme.md to include figma and storybook links Things are getting nice. 2023-01-20 17:04:52 +01:00			`<p align="center">`
📝(doc) update docs to install published packages + contributing guide Updated various parts of existing documentations to make a clean path to learn how to install the library. I let the most complicated part in the tokens's README.md file, which is referenced from the Storybook. 2023-01-30 15:00:46 +01:00			`<a href="https://openfun.github.io/cunningham"><b>📚  Documentation</b></a> •`
			`<a href="https://www.figma.com/file/sSEMhow3g5zpEkyDLEQ1ZO/DS-Cunningham?node-id=47%3A261&t=nKRnadK4sslyVxD7-0"><b>🖌️  Figma</b></a>`
📝(readme) update readme.md to include figma and storybook links Things are getting nice. 2023-01-20 17:04:52 +01:00			`</p>`

📝(global) add README.md Create a first version of README.md 2022-12-01 14:50:15 +01:00			`## Getting started`
🔧(global) setup Turborepo and package.json Add configuration files to make use of Turborepo. Setup constraints values for package.json regarding node and package manager. 2022-12-01 12:01:10 +01:00
📝(doc) update docs to install published packages + contributing guide Updated various parts of existing documentations to make a clean path to learn how to install the library. I let the most complicated part in the tokens's README.md file, which is referenced from the Storybook. 2023-01-30 15:00:46 +01:00			`Everything is detailed on our [documentation](https://openfun.github.io/cunningham). 📚`
🔧(global) setup Turborepo and package.json Add configuration files to make use of Turborepo. Setup constraints values for package.json regarding node and package manager. 2022-12-01 12:01:10 +01:00
📝(global) add README.md Create a first version of README.md 2022-12-01 14:50:15 +01:00			`## Contributing`
🔧(global) setup Turborepo and package.json Add configuration files to make use of Turborepo. Setup constraints values for package.json regarding node and package manager. 2022-12-01 12:01:10 +01:00
📝(doc) update docs to install published packages + contributing guide Updated various parts of existing documentations to make a clean path to learn how to install the library. I let the most complicated part in the tokens's README.md file, which is referenced from the Storybook. 2023-01-30 15:00:46 +01:00			`Please see our [contributing guidelines](./CONTRIBUTING.md).`
🔧(global) setup Turborepo and package.json Add configuration files to make use of Turborepo. Setup constraints values for package.json regarding node and package manager. 2022-12-01 12:01:10 +01:00
📝(global) add README.md Create a first version of README.md 2022-12-01 14:50:15 +01:00			`## License`
🔧(global) setup Turborepo and package.json Add configuration files to make use of Turborepo. Setup constraints values for package.json regarding node and package manager. 2022-12-01 12:01:10 +01:00
🎨(all) global lint Executiing `yarn format` should not generate any changes in the project. Apply yarn format to all files. 2023-05-04 15:58:06 +02:00			`This work is released under the MIT License (see [LICENSE](./LICENSE)).`