Skip to content

Commit 14ecf54

Browse files
authored
Update README.md
1 parent 8ce987b commit 14ecf54

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,21 @@
44

55
![CleanShot 2022-06-11 at 22 54 15@2x](https://user-images.githubusercontent.com/54872601/173192927-ca2a8bef-2114-44f8-8d4d-47baadb8b4a8.png)
66

7-
## Main Features with Changelog (Ascending)
8-
- Auto trigger/pop-up the `.sheet` from Version and/or Build ~~increase~~ changes (starting from 4.0.0)
9-
- One-line Coding
10-
- JSON-based Structure
11-
- Versioning + View History (2.0.0 or above)
12-
- Instant Loading from Local Storage
13-
- Simple Binding and Passing Data
14-
- Simple Model, Easy to Modify and Reuse
15-
- Allows for ALL Use Cases including Commercial / Non-profit
16-
- Support Remote JSON File (3.0.0 or above)
17-
- Support Firebase Real-Time Database (3.0.0 or above)
18-
- Support Remote Drop Notification (3.5.0 or above)
19-
- Support App Icon (3.9.6 or above)
20-
- Support Version Number in x.y.z and/or x.y (4.0.0 or above)
21-
- Support visionOS & Vision Pro (4.1.0 or above)
22-
- Support Mesh Gradient and Linear Gradient Background (5.3.0 or above)
7+
## Changelog
8+
| New (Core) Features | Version |
9+
|-----------------------------------------------------------------|-----------|
10+
| Mesh Gradient and Linear Gradient Background | 5.3.0 |
11+
| Apple visionOS & Vision Pro | 4.1.0 |
12+
| Auto trigger/pop-up .sheet when Version / Build changes | 4.0.0 |
13+
| Version Number in x.y.z and/or x.y | 4.0.0 |
14+
| Remote Drop Notification | 3.5.0 |
15+
| Firebase Real-Time Database | 3.0.0 |
16+
| Remote JSON File | 3.0.0 |
17+
| Versioning + View History | 2.0.0 |
18+
| Allows for ALL Use Cases including Commercial / Non-profit | - |
19+
| Simple Model, Easy to Modify and Reuse | - |
20+
| Simple Binding and Passing Data | - |
21+
| Instant Loading from Local Storage | - |
2322

2423
## Preview
2524
![IMG_3472](https://user-images.githubusercontent.com/54872601/173187065-14d78119-47e7-4dcb-a3e6-c7fee4f0c67f.PNG) | ![IMG_3471](https://user-images.githubusercontent.com/54872601/173187067-fe3b5cac-54b5-4482-b73f-42e6c500546f.PNG)
@@ -34,7 +33,7 @@ History View (2.0.0) | App Icon (3.9.6) [Vertical / Horizontal]
3433
------------- | ------------
3534
Support VisionOS (4.1.0 or above) | Mesh Gradient Background (5.3.0 or above)
3635

37-
## Sample
36+
## Example
3837
Path: `./Demo` (Xcode Project with SwiftUI)
3938

4039
## Version
@@ -47,7 +46,7 @@ Path: `./Demo` (Xcode Project with SwiftUI)
4746
### Xcode Local
4847
Tested on | Latest | Compatible
4948
--------- | ------ | ----------
50-
iOS | 18.2 | > 14
49+
iOS | 18.4 | > 14
5150
iPadOS | 18.2 | > 14
5251
macOS | 15.2 | > 11
5352
visionOS | 2 | > 1
@@ -80,17 +79,17 @@ import SwiftNEW
8079
### States
8180
var | Suggested | Options | Type
8281
----------- | ------------------------------- | ----------------------------- | ----
83-
showNew | false | false, true | Bool
82+
showNew * | false | false, true | Bool
8483
align | .center | .leading, .center, .trailing | HorizontalAlignment
8584
color | .accentColor | All Colors Supported | Color
8685
size | "simple" | "invisible", "mini", "simple" | String
87-
labelColor | Color(UIColor.systemBackground) or Color(NSColor.windowBackgroundColor) | All Colors Supported | Color
86+
labelColor | UIColor.systemBackground or NSColor.windowBackgroundColor | All Colors Supported | Color
8887
label | "Show Release Note" | All Strings | String
8988
labelImage | "arrow.up.circle.fill" | All SF Symbols | String
9089
history | true | true, false | Bool
9190
data | "data" or "https://.../{}.json" | "{LOCAL_JSON_FILE}" or Remote | String
9291
showDrop | false | false, true | Bool
93-
mesh | false | false, true | Bool
92+
mesh | true | false, true | Bool
9493

9594

9695
##### Samples:
@@ -130,7 +129,7 @@ Instead of using separate states, inline states work too. (No longer required af
130129
SwiftNEW(show: $showNew, align: .constant(.center), color: .constant(.accentColor), size: .constant("normal"), labelColor: .constant(Color(UIColor.systemBackground)), label: .constant("Show Release Note"), labelImage: .constant("arrow.up.circle.fill"), history: .constant(true), data: .constant("data"), showDrop: .constant(false))
131130
```
132131

133-
4. Your code should at least look similar to the following, including the minimum features and default styles.
132+
4. Your code should look similar to the following, including the minimum features and default styles.
134133
```swift
135134
struct ContentView: View {
136135
@State var showNew: Bool = false
@@ -232,12 +231,13 @@ Translation (i18n) Sample Available in v```3.9.7``` or above
232231
- If you want to discuss future roadmap or contribution, please find on Discussions.
233232

234233
## FAQ
235-
Q1. Why did the sheet not popup/show loading/show blank?<br />
236-
A1. Firstly, be sure the latest version in JSON is matching your app version. If you are using data.json locally, please check ```,``` is missing or if any typo causes the JSON to no longer be valid. If you are using remote data (e.g. Firebase), make sure the JSON structure is the same as the example.<br />
234+
Q1. Why didn’t the sheet pop up, show loading, or display a blank screen?<br />
235+
A1. First, ensure that the latest version in JSON matches your app version. If you are using a local data.json file, check for any missing commas(,) or typos that could make the JSON invalid.
236+
If you are using remote data (such as Firebase), confirm that the JSON structure is the same as the provided example.<br />
237237
Q2. How can I contribute to the project?<br />
238-
A2. Simply pull a request, and someone will review your code. If everything is okay, your changes will be merged and reflected in the next minor version.<br />
239-
Q3. Can I use it in Educational (includ. Student's Homework, Class's demo) or NGO or Commerical Projects?<br />
240-
A3. YES. This project is under the license of MIT. Feel free to use it :)
238+
A2. Simply pull a request, and the admin will review your code. If everything is okay, your changes will be merged and reflected in the next minor version.<br />
239+
Q3. Can I use it in Educational (include Student's Homework, Class's demo) or NGO or Commerical Projects?<br />
240+
A3. YES. This project is under the license of MIT. Feel free to play it :)
241241

242242
## License
243243
MIT

0 commit comments

Comments
 (0)