Skip to content

Commit

Permalink
reword the top of the README (#180)
Browse files Browse the repository at this point in the history
* reword the top of the README, reference MeetingNotes and Automerge-Repo (Swift)
* mention interop with JS AutomergeRepo
  • Loading branch information
heckj authored May 30, 2024
1 parent 727a8e2 commit 64358eb
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Automerge-swift

An Automerge implementation for swift.
The project is an [Automerge](https://automerge.org) implementation, a library of data structures for building collaboraative applications, in Swift.
Automerge is cross platform and cross-language, allowing you to provide collaboration support between browsers and native apps.

This is a low-level library with few concessions to ergonomics, meant to interact directly with the low-level Automerge API.
Additional API that is more ergonomic is being added into the repository as this project evolves.
The [API Documentation](https://automerge.org/automerge-swift/documentation/automerge/) provides an overview of this library and how to use it.

[Automerge-Swift API Documentation](https://automerge.org/automerge-swift/documentation/automerge/) is available on the [Automerge site](https://automerge.org/).
A command-line demonstration application ([contaaacts](https://github.com/automerge/contaaacts)) is available that shows using the lower level API.
[Automerge Repo (Swift)](http://github.com/automerge/automerge-repo-swift/) is a supplemental library that extends this library.
It adds pluggable network and storage support for Apple platforms for a more "batteries included" result, and is tested with the [JavaScript version of Automerge Repo](https://github.com/automerge/automerge-repo).

Note: There was an earlier Swift language bindings for Automerge here at automerge/automerge-swift.
The repository was [renamed and archived](https://github.com/automerge/automerge-swift-archived), but is available if you are looking for it.
The open-source iOS and macOS document-based SwiftUI App [MeetingNotes](https://github.com/automerge/meetingnotes/) provides a show-case for how to use Automerge to build a live, collaborative experience.
MeetingNotes builds over both this library and the repository to provide both WebSocket and peer to peer based networking in the app.

## Quickstart

Expand Down Expand Up @@ -49,3 +49,5 @@ try! doc.merge(other: doc2) // `doc` now contains {"colours": ["green", "red"]}
```

For more details on the API, see the [Automerge-swift API documentation](https://automerge.org/automerge-swift/documentation/automerge/) and the articles within.

> Note: There was an earlier project that provided Swift language bindings for Automerge. The repository was [renamed and archived](https://github.com/automerge/automerge-swift-archived), but is available if you are looking for it.

0 comments on commit 64358eb

Please sign in to comment.