Skip to content

Commit 59ed229

Browse files
committed
Add
1 parent 78d0134 commit 59ed229

File tree

1 file changed

+35
-42
lines changed

1 file changed

+35
-42
lines changed

README.md

Lines changed: 35 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<img src="https://user-images.githubusercontent.com/0000000/0000000-kore-logo.png" alt="KoreUI Logo" height="120" />
2+
<img src="https://github.com/TheJupiterDev/KoreUI/blob/main/assets/logo.png" alt="KoreUI Logo" height="120" />
33
</p>
44

55
<h1 align="center">KoreUI</h1>
@@ -11,6 +11,10 @@
1111

1212
---
1313

14+
> ⚠️ This project is still in pre alpha stages!
15+
16+
---
17+
1418
## 🚀 Features
1519

1620
- 📄 Full support for JSON Schema Draft 2020-12
@@ -26,11 +30,11 @@
2630

2731
Run the following:
2832

29-
pip install -r requirements.txt
33+
```pip install pyside6```
3034

3135
Requirements:
3236

33-
- Python 3.8+
37+
- Python 3.10+
3438
- PySide6
3539

3640
---
@@ -39,57 +43,45 @@ Requirements:
3943

4044
To start the application:
4145

42-
python app.py
46+
```python app.py```
4347

44-
Edit the `schema.json` file to customize your form structure.
48+
Edit the `example_schema.json` file to customize your form structure.
4549

4650
---
4751

4852
## 🧪 Example Schema
49-
50-
{
51-
"type": "object",
52-
"properties": {
53-
"mode": {
54-
"type": "string",
55-
"enum": ["simple", "advanced"]
53+
```json
54+
{
55+
"type": "object",
56+
"properties": {
57+
"mode": {
58+
"type": "string",
59+
"enum": ["simple", "advanced"]
60+
},
61+
"settings": {
62+
"if": {
63+
"properties": { "mode": { "const": "advanced" } }
5664
},
57-
"settings": {
58-
"if": {
59-
"properties": { "mode": { "const": "advanced" } }
60-
},
61-
"then": {
62-
"properties": { "threshold": { "type": "number" } }
63-
},
64-
"else": {
65-
"properties": { "notes": { "type": "string" } }
66-
},
67-
"type": "object"
68-
}
69-
}
65+
"then": {
66+
"properties": { "threshold": { "type": "number" } }
67+
},
68+
"else": {
69+
"properties": { "notes": { "type": "string" } }
70+
},
71+
"type": "object"
7072
}
71-
72-
---
73-
74-
## 📸 Screenshot
75-
76-
*(Optional: include a screenshot of a rendered form here)*
73+
}
74+
}
75+
```
7776

7877
---
7978

8079
## 🧱 Architecture
8180

82-
- `koreui.py` – Core schema resolver, validator, and widget logic
81+
- `src/koreui.py` – Core schema resolver, validator, and widget logic
82+
- `src/loader.py` – A helper script to load a Schema from a JSON
8383
- `app.py` – App entry point
84-
- `schema.json` – Example JSON Schema used to render a dynamic form
85-
86-
---
87-
88-
## 🧩 Logo
89-
90-
Replace the logo link at the top with your own hosted image or use one from your `assets/` folder. Example:
91-
92-
<img src="assets/logo.png" alt="KoreUI Logo" height="120" />
84+
- `example_schema.json` – Example JSON Schema used to render a dynamic form
9385

9486
---
9587

@@ -101,4 +93,5 @@ MIT License — free for personal and commercial use.
10193

10294
## 🙌 Credits
10395

104-
Built with ❤️ using PySide6, JSON Schema, and caffeine.
96+
Built using PySide6, JSON Schema, and caffeine.
97+
And maybe a little AI.

0 commit comments

Comments
 (0)