File tree 1 file changed +15
-8
lines changed
1 file changed +15
-8
lines changed Original file line number Diff line number Diff line change @@ -14,17 +14,22 @@ Currently, this project is in early development.
14
14
15
15
You can find the API [ documentation] ( https://swiftpackageindex.com/OpenSwiftUIProject/OpenSwiftUI/main/documentation/openswiftui ) here.
16
16
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) .
21
21
>
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.
23
23
24
24
## Usage
25
25
26
26
See Example folder and try it with ExampleApp
27
27
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
+
28
33
## Build
29
34
30
35
### Build without testing framework
@@ -62,10 +67,12 @@ for various platforms:
62
67
[ ^ 4 ] : Build is supported. Test is not supported yet dut to upstream issue.
63
68
64
69
> [ !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.
67
73
>
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.
69
76
70
77
## License
71
78
You can’t perform that action at this time.
0 commit comments