update docs

README.md

@@ -2,9 +2,9 @@
 
 Basic [beancount](https://github.com/beancount/beancount) clone (one day...) in Rust!
 
-Using [pest](https://pest.rs/) for parsing. Two useful links:
-- [pest bootstrap parsing](https://github.com/pest-parser/pest/tree/master/meta/src)
-- [playground](https://pest.rs/#editor)
+Still very very alpha and doesn't do most things that are necessary to be at all useful.
+
+Using [pest](https://pest.rs/) for parsing.
 
 Planned features:
 - [x] Parse beancount files
@@ -16,11 +16,13 @@ Planned features:
 - [x] Validate `balance` directives
 - [x] Pad statements
 - [x] Open/close with multiple currencies
+- [ ] Support `includes`
+- [ ] Come up with a more punny name
 - [ ] Currency conversions
 - [ ] Price/cost and FIFO
+- [ ] Add Python bindings
 
-## (Deliberate*) differences from beancount
-- Permitted transaction flags are limited to `*` `!` `txn`
+## (Deliberate) differences from beancount
 - Postings can't omit the currency
 
 ## Usage
@@ -30,20 +32,34 @@ cargo install bean-rs
 ```
 
 ### Run
-```
+```bash
 $ bean-rs
 
+Usage: bean-rs <COMMAND>
+
 Commands:
-  balance
+  balance  Display account balances
+  check    Check for errors and quit
   help     Print this message or the help of the given subcommand(s)
 
 Options:
   -h, --help     Print help
   -V, --version  Print version
 ```
 
+#### Calculate balances
+```bash
+bean-rs balance example.bean
+```
+
+
 ## Development
 ### Build
 ```bash
 make build
 ```
+
+### Test
+```bash
+make test
+```

grammar.pest

@@ -50,7 +50,7 @@ at_price       =  { "@" ~ (space+ ~ number)? ~ space+ ~ ccy }
 metadata_added = _{ (NEWLINE ~ metadata) }
 metadata       =  { space+ ~ key ~ ":" ~ space* ~ val }
 
-txn_type       =  { "*" | "!" | "txn" }
+txn_type       =  { "*" | "!" | "txn" | ASCII_ALPHA+ }
 key            = @{ ASCII_ALPHA_LOWER ~ (ASCII_ALPHANUMERIC | "-" ~ ASCII_ALPHANUMERIC)* }
 tagkey         = @{ ASCII_ALPHANUMERIC ~ (ASCII_ALPHANUMERIC | "-" ~ ASCII_ALPHANUMERIC)* }
 val            = @{ quoted | ASCII_ALPHA* }

src/directives.rs

@@ -512,7 +512,7 @@ pub struct Transaction {
     ty: String,
     payee: Option<String>,
     narration: String,
-    tag: Option<String>, // TODO can have multiple
+    tag: Option<String>,  // TODO can have multiple
     link: Option<String>, // TODO can have multiple
     pub postings: Vec<Posting>,
     meta: Vec<Metadata>,

src/error.rs

@@ -4,9 +4,9 @@ use crate::directives::{DebugLine, Directive};
 
 #[derive(Clone, Debug, Eq, Hash, PartialEq)]
 pub enum ErrorType {
-    Parse,        // parse error from Pest
-    Into,         // error while going into `root` pair
-    Badline,      // un-parseable line found in input
+    Parse,   // parse error from Pest
+    Into,    // error while going into `root` pair
+    Badline, // un-parseable line found in input
     MultipleEmptyPostings,
     UnbalancedTransaction,
     NoAccount,

src/lib.rs

@@ -31,7 +31,8 @@ fn load(text: String) -> (Vec<Directive>, Vec<BeanError>) {
     (dirs, errs)
 }
 
-/// Load the file at `path` and print the balance
+/// Load the file at `path`
+/// Optionally print the balance if `print_bals=true`
 pub fn balance(path: &String, print_bals: bool) {
     let text = std::fs::read_to_string(path).expect("cannot read file");
     let (mut dirs, mut errs) = load(text);

src/main.rs

@@ -11,7 +11,9 @@ struct Cli {
 
 #[derive(Subcommand)]
 enum Commands {
+    /// Display account balances
     Balance { path: String },
+    /// Check for errors and quit
     Check { path: String },
 }