Skip to content

Commit 8ff4084

Browse files
committed
Adjust the README to mention new capabilities & minor changes
1 parent fd860bc commit 8ff4084

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
![ErrorKit Logo](https://github.com/FlineDev/ErrorKit/blob/main/Logo.png?raw=true)
22

3+
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FFlineDev%2FErrorKit%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/FlineDev/ErrorKit)
34
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FFlineDev%2FErrorKit%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/FlineDev/ErrorKit)
45

56
# ErrorKit
@@ -69,7 +70,7 @@ do {
6970
}
7071
```
7172

72-
These enhanced descriptions are community-provided and fully localized mappings of common system errors to clearer, more actionable messages.
73+
These enhanced descriptions are community-provided and fully localized mappings of common system errors to clearer, more actionable messages. ErrorKit comes with built-in mappers for Foundation, CoreData, MapKit, and more. You can also create custom mappers for third-party libraries or your own error types.
7374

7475
[Read more about Enhanced Error Descriptions →](https://swiftpackageindex.com/FlineDev/ErrorKit/documentation/errorkit/enhanced-error-descriptions)
7576

@@ -179,7 +180,7 @@ Button("Report a Problem") {
179180
)
180181
```
181182

182-
With just a simple SwiftUI modifier, you can automatically include all log messages from Apple's unified logging system.
183+
With just a simple built-in SwiftUI modifier and the `logAttachment` helper function, you can easily include all log messages from Apple's unified logging system and let your users send them to you via email. Other integrations are also supported.
183184

184185
[Read more about User Feedback and Logging →](https://swiftpackageindex.com/FlineDev/ErrorKit/documentation/errorkit/user-feedback-with-logs)
185186

@@ -193,6 +194,8 @@ ErrorKit's features are designed to complement each other while remaining indepe
193194

194195
3. **Save time with ready-made tools**: built-in error types for common scenarios and simple log collection for user feedback.
195196

197+
4. **Extend with custom mappers**: Create error mappers for any library to improve error messages across your entire application.
198+
196199
## Adoption Path
197200

198201
Here's a practical adoption strategy:

0 commit comments

Comments
 (0)