update readme and bump version

hyperware-ai · Jun 17, 2024 · f9fc246 · f9fc246
1 parent 3cc8ba0
commit f9fc246
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 11 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "kinode_process_lib"
 description = "A library for writing Kinode processes in Rust."
-version = "0.8.2"
+version = "0.8.3"
 edition = "2021"
 license-file = "LICENSE"
 homepage = "https://kinode.org"

diff --git a/README.md b/README.md
@@ -1,11 +1,5 @@
-# process_lib
+# kinode_process_lib
 
-Library of functions for more ergonomic kinode process development.
+Library of functions for more ergonomic [Kinode](https://github.com/kinode-dao/kinode) process development. See the [Kinode Book](https://book.kinode.org) for a guide on how to use this library to write Kinode apps in Rust.
 
-To develop/build:
-```
-git submodule update --init
-cargo build
-```
-
-Docs: waiting on other crates to be published.
+The major version of `kinode_process_lib` will always match the major version of Kinode OS. Since the current major version of both is 0, breaking changes can occur on minor releases. Once the major version reaches 1, breaking changes will only occur between major versions. As is, developers may have to update their version of process_lib as they update Kinode OS.