Skip to content

Commit 2b0da4d

Browse files
committed
Update README
1 parent aaba085 commit 2b0da4d

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

+15-8
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,22 @@ Currently, this project is in early development.
1414

1515
You can find the API [documentation](https://swiftpackageindex.com/OpenSwiftUIProject/OpenSwiftUI/main/documentation/openswiftui) here.
1616

17-
> [!IMPORTANT]
18-
> Please **DO NOT** use this package in production environment on Apple platform
19-
> (eg. App Store and Mac App Store) since this package use a lot of hidden and
20-
> private API here.
17+
> [!WARNING]
18+
> This package use a lot of hidden API and private framework on Apple platform.
19+
>
20+
> Please **DO NOT** use this package in Apple's production environment(eg. App Store).
2121
>
22-
> It may break your build or crash your app at any future SDK/OS update.
22+
> Otherwize it may break your build or crash your app at any future SDK/OS update.
2323
2424
## Usage
2525

2626
See Example folder and try it with ExampleApp
2727

28+
> [!IMPORTANT]
29+
> Clone OpenGraph in the same directory before running the example.
30+
>
31+
> See [Example/README.md](Example/README.md) for more detail.
32+
2833
## Build
2934

3035
### Build without testing framework
@@ -62,10 +67,12 @@ for various platforms:
6267
[^4]: Build is supported. Test is not supported yet dut to upstream issue.
6368

6469
> [!NOTE]
65-
> Due to the current limited implementation level of OpenGraph.
66-
> It is only API compatible with AttributeGraph.
70+
> The cross-platform OpenGraph is not fully implemented.
71+
>
72+
> It is only API compatible with AttributeGraph now.
6773
>
68-
> Most of the core feature is only available on Apple platform built with AttributeGraph varient.
74+
> So most of the core feature is only available on Apple platform built with
75+
> AttributeGraph varient.
6976
7077
## License
7178

0 commit comments

Comments
 (0)