From 8eb041086619505900f7e526bb69014e2fe36178 Mon Sep 17 00:00:00 2001
From: Augusto Hack <hack.augusto@gmail.com>
Date: Tue, 5 Mar 2024 09:13:51 +0100
Subject: [PATCH] docs: expand the README for miden-objects (#501)

---
 objects/README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 50 insertions(+), 1 deletion(-)

diff --git a/objects/README.md b/objects/README.md
index 0c1b1be8a..3959e5096 100644
--- a/objects/README.md
+++ b/objects/README.md
@@ -1,3 +1,52 @@
 # Miden Objects
 
-Core components of the Polygon Miden rollup.
+This crates contains core components defining the Miden rollup protocol.
+
+## Modules
+
+Here is a broad overview of each module, with links to additional documentation.
+
+
+### Accounts
+
+Structures used to define accounts, including abstractions over its code, storage, and vault.
+
+[Documentation](https://0xpolygonmiden.github.io/miden-base/architecture/accounts.html).
+
+### Assets
+
+Structures used to define fungible and non-fungible assets. Accounts own assets and store them in their vaults.
+
+[Documentation](https://0xpolygonmiden.github.io/miden-base/architecture/assets.html)
+
+
+### Block
+
+Structures used to define a block. These objects contains authentication structures, merkle trees, used to represent the state of the rollup at a given point in time.
+
+### Notes
+
+Structures used to define notes. Notes are messages that contain code and assets. They describe their own behavior and allow for interaction among accounts. Notes come in multiple flavors, refer to the docs for additional details.
+
+[Documentation](https://0xpolygonmiden.github.io/miden-base/architecture/notes.html)
+
+### Transaction
+
+Structures used to define Miden rollup transactions. Transactions describe changes to an account, and may include consumption and production of notes. The objects in this module allow for the representation of transactions at multiple stages of its lifecycle, from creation, to data aggregation, execution with trace collection, and finally an executed transaction with a corresponding STARK proof.
+
+[Documentation](https://0xpolygonmiden.github.io/miden-base/architecture/transactions.html).
+
+## Features
+
+Description of this crate's feature:
+
+| Features     | Description                                                                                   |
+| ------------ | --------------------------------------------------------------------------------------------- |
+| `std`        | Enable usage of Rust's `std`, use `--no-default-features` for `no-std` support.               |
+| `concurrent` | Enables concurrent code to speed up runtime execution.                                        |
+| `serde`      | Enables serialization of most objects via `serde`.                                            |
+| `testing`    | Enables testing utilities and reduces proof-of-work requirements to speed up tests' runtimes. |
+
+## License
+
+This project is [MIT licensed](../LICENSE).