From d4261c1ed47f2b205020fa66f756eef39d2ffd89 Mon Sep 17 00:00:00 2001
From: Willian Pinheiro <willpinhaaa@gmail.com>
Date: Tue, 15 Oct 2024 23:50:09 -0300
Subject: [PATCH 1/3] Update README.md

---
 README.md | 66 +++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 42 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 2a99648..53c14ed 100644
--- a/README.md
+++ b/README.md
@@ -1,40 +1,58 @@
-# Welcome to React Router!
+<div align="center">
 
--   📖 [React Router docs](https://reactrouter.com/dev)
+<img alt="Mantine Themes" width="120" src="https://github.com/user-attachments/assets/b3d0a9d2-6d86-44cc-b698-b3f80266cf6c" />
 
-## Development
+# Mantine [Themes](https://mantine-themes.willpinha.link)
 
-Run the dev server:
+*Beautiful Mantine themes using semantic colors*
 
-```shellscript
-npm run dev
-```
+</div>
 
-## Deployment
+## About
 
-First, build your app for production:
+**Mantine Themes** offers you a set of themes that you can use with the [Mantine](https://mantine.dev) UI library (React). It is also
+possible to build your own themes in a convenient, simple and fast way
 
-```sh
-npm run build
-```
+Each theme has primary, secondary and tertiary semantic colors so you can customize your frontend with the colors you prefer
 
-Then run the app in production mode:
+Interested in Mantine Themes? [Take a look→]()
 
-```sh
-npm start
-```
+## License
+
+Mantine Theme is under the [MIT License](LICENSE)
 
-Now you'll need to pick a host to deploy it to.
+## Documentation
 
-### DIY
+### 1. How it works?
 
-If you're familiar with deploying Node applications, the built-in app server is production-ready.
+Themes are dynamically generated based on the `createMantineTheme` function located in the
+[create-mantine-theme.ts](https://github.com/willpinha/mantine-themes/blob/master/app/lib/create-mantine-theme.ts) file.
+This function contains all the necessary documentation to use it
 
-Make sure to deploy the output of `npm run build`
+Just copy this file to your project and create your themes
 
--   `build/server`
--   `build/client`
+```tsx
+import { createMantineTheme } from "./create-mantine-theme.ts";
+
+const theme = createMantineTheme({
+  baseHue: 120,
+  baseSaturation: 20,
+  colors: {
+    primary: [...],
+    secondary: [...],
+    tertiary: [...],
+  }
+});
+
+export function App() {
+  return (
+    <MantineProvider theme={theme}>
+      {/* Your application here */}
+    </MantineProvider>
+  );
+}
+```
 
-## Styling
+### 2. How to use a specific theme?
 
-This template comes with [Tailwind CSS](https://tailwindcss.com/) already configured for a simple default starting experience. You can use whatever CSS framework you prefer.
+### 3. How do I create my own themes?

From 4a46369be1d0fab2779facd1792aed1acb39d971 Mon Sep 17 00:00:00 2001
From: Willian Pinheiro <willpinhaaa@gmail.com>
Date: Tue, 15 Oct 2024 23:57:53 -0300
Subject: [PATCH 2/3] Update README.md

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index 53c14ed..660e38f 100644
--- a/README.md
+++ b/README.md
@@ -55,4 +55,13 @@ export function App() {
 
 ### 2. How to use a specific theme?
 
+Mantine Themes-specific themes are located in the [app/themes](https://github.com/willpinha/mantine-themes/tree/master/app/themes) directory.
+Just copy the color theme that interests you
+
 ### 3. How do I create my own themes?
+
+Just use the `createMantineTheme` function and follow the instructions in the function documentation
+
+The base colors (text, background, shadow, border, ...) will have great accessibility by default. It is your duty to ensure that the semantic
+colors (primary, secondary, tertiary) generated with [Colors generator](https://mantine.dev/colors-generator) have good contrast with the base colors
+

From 23f0fe3685a40e8c3f8bbbbdc6a692c29989a829 Mon Sep 17 00:00:00 2001
From: Willian Pinheiro <willpinhaaa@gmail.com>
Date: Tue, 15 Oct 2024 23:58:21 -0300
Subject: [PATCH 3/3] Update README.md

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 660e38f..0135eee 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ possible to build your own themes in a convenient, simple and fast way
 
 Each theme has primary, secondary and tertiary semantic colors so you can customize your frontend with the colors you prefer
 
-Interested in Mantine Themes? [Take a look→]()
+Interested in Mantine Themes? [Take a look→](https://mantine-themes.willpinha.link)
 
 ## License