Skip to content

Commit e7ccbbf

Browse files
committed
doc: readme
1 parent 91a8101 commit e7ccbbf

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Loro-swift
1+
<h1 align="center">loro-swift</h1>
22

33
<p align="center">
44
<a aria-label="X" href="https://x.com/loro_dev" target="_blank">
@@ -13,8 +13,21 @@ This repository contains experimental Swift bindings for [Loro CRDT](https://git
1313

1414
If you have any suggestions for API, please feel free to create an issue or join our [Discord](https://discord.gg/tUsBSVfqzf) community.
1515

16+
## TODO
17+
18+
- [x] `LoroDoc` export and import
19+
- [x] `List`/`Map`/`Text`/`Tree`/`MovableList`/`Counter` Container
20+
- [x] Checkout
21+
- [x] Subscribe Event
22+
- [ ] UndoManager
23+
- [ ] Bindings for all types in Loro
24+
- [ ] Tests
25+
- [ ] Benchmarks
26+
1627
## Usage
1728

29+
**Note: Loro-swift is still under development and no package has been released yet.**
30+
1831
Add the dependency in your `Package.swift`.
1932

2033
```swift
@@ -23,7 +36,7 @@ let package = Package(
2336
products: [......],
2437
dependencies:[
2538
...,
26-
.package(url: "https://github.com/loro-dev/loro-swift.git", from: 0.16.2)
39+
.package(url: "https://github.com/loro-dev/loro-swift.git", from: "0.16.2")
2740
],
2841
targets:[
2942
.executableTarget(

0 commit comments

Comments
 (0)