diff --git a/README.md b/README.md index 6a566b1..bd2f1bd 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,19 @@ Features that have yet to be implemented but are planned: - Improved file slug/id handling - Plugin API +## Example Usage + +```javascript +import { Vault } from "@foundry/hammerstone"; + +const vault = new Vault("./my-vault"); +vault.process((document) => { + document.setFrontmatter({ "Last Processed": Date.now() }); +}); + +vault.write(); +``` + ## API ### `new Vault(vaultRootPath)` diff --git a/package.json b/package.json index dbd2020..9eca2ba 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@foundry/hammerstone", - "version": "0.2.0", + "version": "0.3.0", "description": "Load and manipulate Obsidian vault data", "type": "module", "exports": "./bin/hammerstone.js",