commit 099c2f74e1564c6e554e2fdb79ea2e50332b5ff0
parent f654207ff47c3dac289434ceea4ad21bc79aa89e
Author: lash <dev@holbrook.no>
Date: Thu, 26 Mar 2026 09:36:48 -0600
Update readme
Diffstat:
1 file changed, 19 insertions(+), 0 deletions(-)
diff --git a/dummy/README b/dummy/README
@@ -90,6 +90,13 @@ Another entry may be added using the new _truncated state_:
... and so on.
+#### Attaching assets to entries
+
+The `add.py` tool provides the `-x` flag to add a file as an attachment to the entry. The flag can be specified several times.
+
+Although the tool will attempt to auto-detect metadata from the file, there is no support for explicitly defining file metadata in the tool currently.
+
+
### Viewing the ledger
An XML representation of the ledger and its entries may be generated using the corresponding ledger state.
@@ -244,6 +251,18 @@ Sample output of third command:
```
+### Exporting the ledger
+
+Entries can be exported as XML to a directory using the `usawa/runnable/export.py` command.
+
+The input to the export command is the zero-state ledger xml file.
+
+The filename of each entry written to the directory will be its sha512 hash.
+
+Each entry will produce two files, one of them containing the canonical XML for the entry, the other including entry metadata that is not part of the canonicalized data.
+
+
+
## State of development
This software is to be considered proof-of-concept and not safe for use in production in any way.
