From f2fc77aec36c10937eac3c54f6301391fa633612 Mon Sep 17 00:00:00 2001 From: Jeremy Rose Date: Mon, 18 Mar 2024 11:46:27 -0700 Subject: [PATCH] further improve readme --- README.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c7140e2..f197083 100644 --- a/README.md +++ b/README.md @@ -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