Merge pull request #35 from egraphs-good/oflatt-prepare-release

Move readme to rust docs

Author: oflatt

Cargo.toml

@@ -2,6 +2,11 @@
 name = "egglog-experimental"
 version = "0.1.0"
 edition = "2024"
+description = "Experimental extensions to the egglog language."
+repository = "https://github.com/egraphs-good/egglog-experimental"
+keywords = ["e-graphs", "egglog", "datalog", "compiler", "equality"]
+license = "MIT"
+readme = "README.md"
 
 [[test]]
 harness = false

README.md

@@ -22,11 +22,7 @@ To use it in a Rust project, you can add it as a dependency in a `Cargo.toml` fi
 egglog-experimental = "1.0"
 ```
 
-## Implemented extensions
-
-* `for`-loops ([demo](https://egraphs-good.github.io/egglog-demo/?example=for))
-* `with-ruleset` ([demo](https://egraphs-good.github.io/egglog-demo/?example=with-ruleset))
-* Rationals ([demo](https://egraphs-good.github.io/egglog-demo/?example=rational), see `src/rational.rs` for supported primitives)
-* Dynamic cost model with `set-cost` ([demo](https://egraphs-good.github.io/egglog-demo/?example=05-cost-model-and-extraction))
-* Running custom schedulers with `run-with` ([demo](https://egraphs-good.github.io/egglog-demo/?example=math-backoff))
-* `(get-size!)` primitive for querying the total number of tuples in the database (optionally restricted to a list of table names) ([demo](tests/web-demo/node-limit.egg))
+## Documentation
+
+Check out the crate documentation (built locally) for the current list of implemented extensions, API details, and demo links.
+We plan to do a release on crates.io with the release of egglog 2.0.

src/lib.rs

@@ -1,8 +1,29 @@
+//! # egglog-experimental
+//!
+//! This crate layers several experimental features on top of the core
+//! [`egglog`](https://github.com/egraphs-good/egglog) language and runtime.
+//! It can serve as a standard library when building equality
+//! saturation workflows in Rust.
+//!
+//! ## Implemented extensions
+//!
+//! - [`for`-loops](https://egraphs-good.github.io/egglog-demo/?example=for)
+//! - [`with-ruleset`](https://egraphs-good.github.io/egglog-demo/?example=with-ruleset)
+//! - [Rationals support](https://egraphs-good.github.io/egglog-demo/?example=rational)
+//!   (see [`rational`] for the exposed primitives)
+//! - [Dynamic cost models with `set-cost`](https://egraphs-good.github.io/egglog-demo/?example=05-cost-model-and-extraction)
+//! - [Custom schedulers via `run-with`](https://egraphs-good.github.io/egglog-demo/?example=math-backoff)
+//! - [`(get-size!)` primitive](https://github.com/egraphs-good/egglog-experimental/blob/main/tests/web-demo/node-limit.egg)
+//!   for inspecting total tuple counts, optionally restricted to specific tables
+//!
+//! Each bullet links to a runnable demo so you can explore the feature quickly.
+//! The rest of this crate exposes the Rust APIs and helpers that back these extensions.
+//!
 use egglog::prelude::{RustSpan, Span, add_base_sort};
 pub use egglog::*;
 use std::sync::Arc;
 
-mod rational;
+pub mod rational;
 pub use rational::*;
 mod sugar;
 pub use sugar::*;