Skip to content

Commit 516031a

Browse files
authored
Update README.md
1 parent 35454fb commit 516031a

1 file changed

Lines changed: 18 additions & 10 deletions

File tree

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,22 @@
88
Provide an easy way for Apple Developers to Show "What's New" to the end users.
99

1010
## Features
11-
- Auto trigger / pop-up the `.sheet` from Version and/or Build ~~increase~~ changes (starting from 4.0.0)
11+
- Auto trigger/pop-up the `.sheet` from Version and/or Build ~~increase~~ changes (starting from 4.0.0)
1212
- One-line Coding
1313
- JSON Compatible
1414
- Data Versioning
1515
- View History (2.0.0 or above)
1616
- Fast Loading from local storage
17-
- Simple Binding and pass data
17+
- Simple Binding and passing data
1818
- Simple Model, easy to modify
1919
- Open Source for all developers
2020
- Support Remote JSON File (3.0.0 or above)
21-
- Support Firebase Real Time Database (3.0.0 or above)
21+
- Support Firebase Real-Time Database (3.0.0 or above)
2222
- Support Remote Drop Notification (3.5.0 or above)
2323
- Support App Icon (3.9.6 or above)
2424
- Support Version Number in x.y.z and/or x.y (4.0.0 or above)
2525
- Support visionOS & Vision Pro (4.1.0 or above)
26+
- Support Mesh Gradient and Linear Gradient Background (5.3.0 or above)
2627

2728
## Preview
2829
![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)
@@ -95,6 +96,8 @@ labelImage | "arrow.up.circle.fill" | All SF Symbols |
9596
history | true | true, false | Bool
9697
data | "data" or "https://.../{}.json" | "{LOCAL_JSON_FILE}" or Remote | String
9798
showDrop | false | false, true | Bool
99+
mesh | false | false, true | Bool
100+
98101

99102
##### Samples:
100103
```swift
@@ -112,19 +115,24 @@ showDrop | false | false, true |
112115
@State var history: Bool = true
113116
@State var data: String = "data"
114117
@State var showDrop: Bool = false
118+
@State var mesh: Bool = false
115119
```
116120

117121
3. Then, paste this code inside `body` or any `some View`.
118122
```swift
123+
// Simplified with default options in 5.2.0 or above
124+
SwiftNEW(show: $showNew)
125+
// 5.1.0 or below
119126
SwiftNEW(show: $showNew, align: $align, color: $color, size: $size, labelColor: $labelColor, label: $label, labelImage: $labelImage, history: $history, data: $data, showDrop: $showDrop)
120127
```
121-
Instead of using seperate states, inline states works too. *`Show Bool` cannot be inline.
128+
Instead of using separate states, inline states work too. (No longer required after 5.2.0)
129+
*`Show Bool` cannot be inline.
122130
```swift
123131
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))
124132
```
125133

126134
### JSON
127-
#### Structure / Model
135+
#### Structure / Model (REF)
128136
* The below code is just for reference only. You don't need to copy the structure or model.
129137
```swift
130138
public struct Vmodel: Codable, Hashable {
@@ -206,21 +214,21 @@ Copy the JSON sample to `data.json` file (If you don't have it, simply create a
206214
]
207215
```
208216

209-
i18n Sample Available in v```3.9.7```
217+
i18n (Native Translation) Sample Available in v```3.9.7```
210218

211219
<img width="249" alt="CleanShot 2023-01-02 at 17 58 49@2x" src="https://user-images.githubusercontent.com/54872601/210216593-5b9aaf46-5684-48d2-994e-831e5d421f76.png">
212220

213221
## Developer Note
214-
- Please report bugs in Issues section.
222+
- Please report bugs in the Issues section.
215223
- If you want to discuss future roadmap or contribution, please find on Discussions.
216224

217225
## FAQ
218226
Q1. Why did the sheet not popup/show loading/show blank?<br />
219-
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 any typo that casue the json no longer valid. If you are using remote data (e.g. Firebase), make sure the json structure is the same as the example.<br />
227+
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 />
220228
Q2. How can I contribute to the project?<br />
221229
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 />
222-
Q3. Can I use it in Educational (includ. Student's Homework, Class's demo) or NGO or Commerical Project?<br />
223-
A3. YES. This project is under license of MIT. Feel free to use it :)
230+
Q3. Can I use it in Educational (includ. Student's Homework, Class's demo) or NGO or Commerical Projects?<br />
231+
A3. YES. This project is under the license of MIT. Feel free to use it :)
224232

225233
## License
226234
MIT

0 commit comments

Comments
 (0)