[Get started](docs/getting-started.md) · [Documentation](docs/index.md) · [Examples](examples/README.md) ·
@@ -25,6 +35,25 @@ Your application supplies storage, transport, keys, secure randomness and time.
The core handles the container rules, cryptography and policy evaluation.
The default core remains buildable for WebAssembly.
+## Quick Start
+
+With Git and Rust installed, clone the repository and run a policy example:
+
+```sh
+git clone https://github.com/AlexiAxAxA/OpenCrate.git
+cd OpenCrate
+cargo run --locked -p oc-policy --example access-policy
+```
+
+It prints an allowed view with obligations, a denied print, and a view denied
+after the lease window. This example uses synthetic facts; your application
+must verify its own inputs and enforce the returned obligations. The first
+Cargo build downloads dependencies and may take more than a minute. No account
+or server is needed. See the [getting started guide](docs/getting-started.md)
+for prerequisites and a signed-header check.
+
+
+
## Files beyond `.cc`
Enable the host-side `app-data` feature to seal the bytes of a file of any
@@ -59,7 +88,8 @@ lease, access policy or revocation; see the
| Small arbitrary file or application value | Opt into `app-data` for a one-recipient sealed-byte envelope outside `.cc` |
These are integration building blocks. Your application enforces the returned
-decisions and obligations. Start with the runnable examples below.
+decisions and obligations. Start with the Quick Start above, then follow the
+[integration guide](docs/getting-started.md).
## What is included
@@ -71,31 +101,6 @@ decisions and obligations. Start with the runnable examples below.
| `oc-policy` | Access decisions from policy and verified caller-provided facts |
| `oc-engine` | Packing plans, per-file secrets and header assembly |
-## Try it
-
-Install Rust through rustup, then run from a terminal:
-
-```sh
-git clone https://github.com/AlexiAxAxA/OpenCrate.git
-cd OpenCrate
-cargo run --locked -p oc-format --example verify-header -- tests/golden/basic.cc
-cargo run --locked -p oc-policy --example access-policy
-```
-
-The first example verifies a real fixture's header signature and reports an
-unknown author until your application pins that identity. The second lets you
-explore a policy with synthetic facts:
-
-```text
-VIEW at t=1100: ALLOW (obligations: ...)
-PRINT at t=1100: DENY (no print permission)
-VIEW at t=2000: DENY (lease window has ended)
-```
-
-Both run locally, without an account or server. Follow the
-[step-by-step guide](docs/getting-started.md) to add the libraries to your own
-Rust application, understand the output and try a damaged-header check.
-
## Designed to be checked
- Frozen known-answer vectors and golden headers accompany the implementation.
@@ -144,3 +149,12 @@ Send only USDT on the TRON (TRC20) network to this address. Other tokens or
other networks (Ethereum, BNB Chain and so on) will be lost. No memo or tag is
needed. Commercial licensing goes through god@closecrate.com, not through this
address.
+
+## Feedback
+
+Questions and improvement ideas are welcome in
+[Issues](https://github.com/AlexiAxAxA/OpenCrate/issues).
+Please report security vulnerabilities through [private reporting](SECURITY.md).
+If Open Crate helped you, please consider
+[starring the repository](https://github.com/AlexiAxAxA/OpenCrate).
+It helps others find the project.
diff --git a/docs/assets/open-crate-mark.svg b/docs/assets/open-crate-mark.svg
new file mode 100644
index 0000000..f8d6da1
--- /dev/null
+++ b/docs/assets/open-crate-mark.svg
@@ -0,0 +1,15 @@
+
diff --git a/docs/assets/quick-start.gif b/docs/assets/quick-start.gif
new file mode 100644
index 0000000..cdc415b
Binary files /dev/null and b/docs/assets/quick-start.gif differ
+
+ 
