Skip to content

Commit d5163bf

Browse files
committed
为所有包添加 MIT 许可证声明,并在根目录中添加 LICENSE 文件
1 parent a2c416d commit d5163bf

12 files changed

Lines changed: 51 additions & 10 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 ObjectQL
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

docs/guide/installation.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,30 @@ Object UI is distributed as several packages:
1616

1717
| Package | Description | Required |
1818
|---------|-------------|----------|
19-
| `@object-ui/protocol` | Type definitions and schemas | Optional |
20-
| `@object-ui/engine` | Core logic and state management | Optional |
21-
| `@object-ui/react` | React integration and hooks | **Yes** |
22-
| `@object-ui/components` | UI component library | **Yes** |
23-
| `@object-ui/designer` | Visual designer (Q3 2026) | Optional |
19+
| `@object-ui/protocol` | Type definitions and schemas | Yes |
20+
| `@object-ui/renderer` | The core compiler that turns JSON into React | Yes |
21+
| `@object-ui/ui` | The visual component library (Shadcn extended) | Yes |
22+
| `@object-ui/designer` | Visual schema editor and builder | Optional |
2423

2524
## Basic Installation
2625

27-
For most projects, you only need two packages:
26+
To get started, install the core packages:
2827

2928
::: code-group
3029

3130
```bash [npm]
31+
npm install @object-ui/renderer @object-ui/ui @object-ui/protocol
32+
```
33+
34+
```bash [pnpm]
35+
pnpm add @object-ui/renderer @object-ui/ui @object-ui/protocol
36+
```
37+
38+
```bash [yarn]
39+
yarn add @object-ui/renderer @object-ui/ui @object-ui/protocol
40+
```
41+
42+
:::bash [npm]
3243
npm install @object-ui/react @object-ui/components
3344
```
3445

docs/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ hero:
1414
link: /guide/introduction
1515
- theme: alt
1616
text: View Roadmap
17-
link: /roadmap
17+
link: /ROADMAP
1818
- theme: alt
1919
text: GitHub
2020
link: https://github.com/objectql/object-ui
@@ -28,9 +28,9 @@ features:
2828
title: Beautiful by Default
2929
details: Professional designs out of the box with Tailwind CSS and Shadcn/UI. Light/dark themes and full customization support.
3030

31-
- icon: 🔧
32-
title: Developer Friendly
33-
details: Full TypeScript support, standard React patterns, and complete control. Export to code anytime.
31+
- icon: �️
32+
title: Visual Designer
33+
details: Drag-and-drop editor to build UIs visually. Real-time preview, property panels, and instant JSON export.
3434

3535
- icon: 🚀
3636
title: Schema Driven

docs/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"name": "object-ui-docs",
33
"version": "0.1.0",
44
"private": true,
5+
"license": "MIT",
56
"type": "module",
67
"scripts": {
78
"dev": "vitepress dev",

examples/designer-demo/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name": "@examples/designer-demo",
33
"private": true,
4+
"license": "MIT",
45
"version": "0.0.0",
56
"type": "module",
67
"scripts": {

examples/prototype/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name": "@examples/prototype",
33
"private": true,
4+
"license": "MIT",
45
"version": "0.0.0",
56
"type": "module",
67
"scripts": {

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name": "object-ui-monorepo",
33
"private": true,
4+
"license": "MIT",
45
"homepage": "https://www.objectui.org",
56
"workspaces": [
67
"packages/*",

packages/designer/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name": "@object-ui/designer",
33
"version": "0.1.0",
4+
"license": "MIT",
45
"description": "The Tool. A drag-and-drop visual editor to generate Object UI schemas.",
56
"main": "dist/index.js",
67
"types": "dist/index.d.ts",

packages/engine/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name": "@object-ui/engine",
33
"version": "0.1.0",
4+
"license": "MIT",
45
"description": "The Brain. Headless logic for handling data.",
56
"main": "dist/index.js",
67
"types": "dist/index.d.ts",

packages/protocol/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name": "@object-ui/protocol",
33
"version": "0.1.0",
4+
"license": "MIT",
45
"description": "The Language. Pure Metadata Definitions & Types.",
56
"main": "dist/index.js",
67
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)