From 7c7e3931a0fc55fb5d2d7d28790a7ae26e101b0f Mon Sep 17 00:00:00 2001 From: Greg Fitzgerald Date: Tue, 20 Mar 2018 15:52:46 -0600 Subject: [PATCH] Better docs --- src/plan.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/plan.rs b/src/plan.rs index 168f788c07..f07bf913b8 100644 --- a/src/plan.rs +++ b/src/plan.rs @@ -1,4 +1,7 @@ -//! The `plan` crate provides functionality for creating spending plans. +//! A domain-specific language for payment plans. Users create Plan objects that +//! are given to an interpreter. The interpreter listens for `Witness` events, +//! which it uses to reduce the payment plan. When the plan is reduced to a +//! `Payment`, the payment is executed. use signature::PublicKey; use chrono::prelude::*;