Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,6 @@ __snapshots__

# Documentation build output
docs/site

# Obsidian E2E failure artifacts
.obsidian-e2e-artifacts
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,23 @@ Here are the features that will help you do that 👇.

Other installation options can be found in the [documentation](https://chhoumann.github.io/PodNotes).

## Development

- `npm run test` runs the jsdom/unit test suite.
- `npm run build` type-checks and bundles the plugin.
- `npm run test:e2e` builds the plugin, then runs the local Obsidian-backed E2E suite.

The E2E suite is local-only. It depends on Obsidian being installed, the
`obsidian` CLI being available on `PATH`, and the target vault being open and
reachable. The default target vault is `dev`; override it with
`PODNOTES_E2E_VAULT` when needed. Failed E2E runs may write artifacts to
`.obsidian-e2e-artifacts/`.

Before running E2E, make sure the target vault's
`.obsidian/plugins/podnotes/main.js` and `manifest.json` symlinks point at this
checkout. The tests intentionally fail during preflight instead of relinking the
vault automatically.

## Screenshots

### Demo
Expand Down
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
"authorUrl": "https://bagerbach.com",
"fundingUrl": "https://buymeacoffee.com/chhoumann",
"isDesktopOnly": false
}
}
Loading
Loading