Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Tweener authored Dec 13, 2024
1 parent 99a8596 commit af79907
Showing 1 changed file with 9 additions and 15 deletions.
24 changes: 9 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,35 +16,29 @@

---

## ⭐️ Introduction
# CZAN

**CZAN** is a design system, named in honor of [Paul Cezanne](https://en.wikipedia.org/wiki/Paul_C%C3%A9zanne), a renowned painter from Aix-en-Provence, France, the developer's hometown.

This framework is specifically adapted for apps running on [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/) and will apply a specific look & feel for the targeted platforms:
- 🤖 **Android**: [Material 3](https://m3.material.io/), Google's open-source design system
- 🍎 **iOS**: Cupertino, Apple's design system
- 🌍 **Web**: Material 3
It is made for apps that use [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/) and is built on [Material 3](https://m3.material.io/), Google's open-source design system.

**CZAN** is following the [Atomic Design](https://bradfrost.com/blog/post/atomic-web-design/) methodology, where atoms, molecules, organisms and templates are the different levels of design you can
use to build your app.

➡️ Be sure to show your support by starring ⭐️ this repository, and feel free to [contribute](#-contributing) if you're interested!

## 📄 Documentation
<br>

Full documentation is available on the [official website](https://www.czan.dev/).
Be sure to show your support by starring ⭐️ this repository, and feel free to [contribute](#-contributing) if you're interested!

## 🗺️ Roadmap
---

The CZAN design system, still in its early stages, has an exciting journey of development ahead. Checkout the [roadmap](https://github.com/users/Tweener/projects/1/views/1) to know all about the
upcoming tasks, presented in no specific order and without set deadlines.
## 📄 Documentation

Feel free to check out the range of `Composable`s that are already available [here](https://github.com/Tweener/czan/tree/main/czan/src/commonMain/kotlin/com/tweener/czan/designsystem)!
Full documentation is available on the [official website](https://www.czan.dev/).

## 👨‍💻 Contributing
## 🤝 Contributing

We love your input and welcome any contributions! Please read our [contribution guidelines](https://github.com/Tweener/czan/blob/master/CONTRIBUTING.md) before submitting a pull request.

## 🪪 Licence
## 📜 Licence

CZAN is licensed under the [Apache-2.0](https://github.com/Tweener/czan?tab=Apache-2.0-1-ov-file#readme).

0 comments on commit af79907

Please sign in to comment.