Skip to content

Commit

Permalink
further improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nornagon committed Mar 18, 2024
1 parent be1bdcf commit f2fc77a
Showing 1 changed file with 7 additions and 11 deletions.
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,20 @@

Python bindings for [Automerge](https://github.com/automerge/automerge).

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.

Note: There is an earlier set of Python bindings for Automerge at
[automerge/automerge-py](https://github.com/automerge/automerge-py), but that
project binds to a very outdated version of Automerge.

## Quickstart

Install the bindings with `pip install automerge`.

Now you can create a document and do all sorts of Automerge things with it!

> Note: this package currently only contains `automerge.core`, which is a
> low-level wrapper around the [Rust automerge
> library](https://docs.rs/automerge/latest/automerge/index.html).
> [!NOTE]
> This package currently only contains `automerge.core`, which is a low-level
> wrapper around the [Rust automerge
> library](https://docs.rs/automerge/latest/automerge/index.html) with few
> concessions to ergonomics
>
> A more ergonomic wrapper is currently in the works.
> A more ergonomic wrapper around this low-level core is currently in the
> works.
```py
from automerge.core import Document, ROOT, ObjType, ScalarType
Expand Down

0 comments on commit f2fc77a

Please sign in to comment.