Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
juyan committed May 25, 2023
1 parent 53ef8d8 commit 878a896
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ Simple, file-based key-value store with full Swift Concurrency support
![Supported Platforms](https://img.shields.io/badge/platform-iOS%2014%20%7C%20macOS%2012-lightgrey)


## Why swift-filestore?
There doesn't seem to exist a fast, nimble key-value persistence solution that works well with Swift Concurrency.
## Why swift-filestore?

If you are looking for a simple key-value store with change stream, but don't want to bridge any closures, or RxSwift/Combine into Swift Concurrency, then swift-filestore could be a good fit.
If your app is built fully under Swift Concurrency, and is in need for a simple key-value storage solution, `swift-filestore` should be a good fit.

It provides basic CRUD operation and a change stream API, all under the paradigm of Swift Concurrency(`async/await`, `AsyncSequence`).

## Quick Start
swift-filestore does not require developers to create new struct/classes for your data model. For example, to use JSON serialization, just have your existing model conform to `JSONDataRepresentable`.
Expand Down

0 comments on commit 878a896

Please sign in to comment.