docs: usage

anthias-labs · Jan 24, 2024 · 666c09c · 666c09c
1 parent 63d93fa
commit 666c09c
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/documentation/src/usage/arbiter_engine.md b/documentation/src/usage/arbiter_engine.md
@@ -1 +1,5 @@
 # Arbiter Engine
+
+WORK IN PROGRESS - NOT STABLE FOR USE YET.
+
+MORE WILL BE ADDED HERE SOON.
diff --git a/documentation/src/usage/index.md b/documentation/src/usage/index.md
@@ -1 +1,15 @@
 # Usage
+Usage of the Arbiter framework is split by each crate.
+
+## Arbiter CLI
+The Arbiter CLI is a minimal interface for managing your Arbiter projects.
+It is built on top of Foundry and aims to provide a similar CLI interface of setting up and interacting with Arbiter projects.
+
+## Arbiter Core
+The `arbiter-core` crate is the core of the Arbiter framework.
+It contains the `Environment` struct which acts as an EVM sandbox and the `RevmMiddleware` which gives a convenient interface for interacting with contracts deployed into the `Environment`.
+(TODO) Direct usage of `arbiter-core` will be minimized as much as possible as it is intended for developers to mostly pull from the `arbiter-engine` crate in the future.
+
+## Arbiter Engine (TODO)
+The `arbiter-engine` crate is the main interface for running simulations.
+It is built on top of `arbiter-core` and provides a more ergonomic interface for designing agents and running them in simulations.