Docs - Readme (#5)

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jordon de Hoog
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,60 @@
 # MaterialKolor Builder
+
+[![Kotlin](https://img.shields.io/badge/kotlin-v2.1.0-blue.svg?logo=kotlin)](http://kotlinlang.org)
+[![Build](https://github.com/jordond/materialkolorbuilder/actions/workflows/ci.yml/badge.svg)](https://github.com/jordond/materialkolorbuilder/actions/workflows/ci.yml)
+[![Release](https://github.com/jordond/materialkolorbuilder/actions/workflows/release.yml/badge.svg)](https://github.com/jordond/materialkolorbuilder/actions/workflows/release.yml)
+[![License](https://img.shields.io/github/license/jordond/MaterialKolorBuilder)](https://opensource.org/license/mit/)
+
+[![Compose Multiplatform](https://img.shields.io/badge/Compose%20Multiplatform-1.7.0-blue)](https://github.com/JetBrains/compose-multiplatform)
+![badge-android](http://img.shields.io/badge/platform-android-6EDB8D.svg?style=flat)
+![badge-desktop](http://img.shields.io/badge/platform-desktop-3750FF.svg?style=flat)
+![badge-wasm](http://img.shields.io/badge/platform-js%2Fwasm-FDD835.svg?style=flat)
+
+A Material3 Theme builder powered by [MaterialKolor](https://github.com/jordond/MaterialKolor).
+
+Visit at [materialkolor.com](https://materialkolor.com).
+
+[mkb-demo.webm](https://github.com/user-attachments/assets/6368a0c3-9df9-416e-81ce-eeb763e74c6e)
+
+## Table of Contents
+
+- [Features](#features)
+- [Platforms](#platforms)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Features
+
+- Generate Material3 themes from a single color
+- Select from a variety of preset images
+- Upload your own image to extract a color from
+- Change other settings like:
+    - Palette Style
+    - Contrast
+    - Etc
+- Export as standard Material Compose code, or a snippet to
+  get [MaterialKolor](https://github.com/jordond/MaterialKolor) up and running.
+
+## Inspiration
+
+The heart of this app comes from the [material-color-utilities](https://github.com/material-foundation/material-color-utilities). A Java library for creating
+Material3 color schemes. I commonized it in my [MaterialKolor](https://github.com/jordond/MaterialKolor) library, and created this app to
+showcase it.
+
+## Platforms
+
+This app is written with Compose Multiplatform, and can be used on the following platforms:
+
+- Android
+- iOS (not tested)
+- JVM (Desktop)
+- Browser (wasm)
+
+## Contributing
+
+Contributions are greatly appreciated! If you find a bug, or have a feature request, please open an
+issue. If you would like to contribute, please open a pull request.
+
+## License
+
+See [LICENSE](LICENSE) for more information.