Add README and MIT LICENSE

This commit is contained in:
Human 2026-06-14 01:09:41 -07:00
parent d2378ca5fc
commit b3437aabea
2 changed files with 103 additions and 0 deletions

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 grub-basket
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

82
README.md Normal file
View file

@ -0,0 +1,82 @@
# Stashpad
A chat-style, nested-notes workspace for [Obsidian](https://obsidian.md). Type at
the bottom, your notes stack and nest, and you drill in and out of the tree, with
optional **Open Knowledge Format (OKF)** export so your notes can be shared with
LLMs and agents.
> ⚠️ **Alpha software.** Stashpad does a lot and is usable daily, but it's young.
> Keep backups of anything important.
> **On how this was made:** the project was designed and directed by its maintainer,
> but the code was written by an AI assistant. That's stated plainly here so no one
> assumes hand-authored, human-reviewed code.
## A tribute
Stashpad is a homage to **Stashpad Notes**, a lovely app discontinued in 2024. This
plugin exists to bring its chat-style, jot-it-down feeling into Obsidian. Sincere
thanks to its founders, **Cara and Theo**, for the original that inspired it.
## Install (via BRAT)
1. Install the **BRAT** community plugin in Obsidian.
2. In BRAT, "Add beta plugin" with this repository: `https://github.com/grub-basket/SP`
3. Enable **Stashpad** in Community Plugins.
## What it does
- **Chat-style capture** — type at the bottom, hit Enter; Shift+Enter for newlines,
with an optional split-on-newlines mode.
- **Outliner** — notes nest under notes, arbitrarily deep; drill in/out, focus any
note as a temporary root.
- **Search** — fast all-tokens/any-order "Sift" search across one folder or every
Stashpad in the vault.
- **Organize** — move/merge/clone/outdent, drag-and-drop re-parenting, manual order,
per-note colors with friendly aliases, pinning, and cross-folder cut/copy/paste of
whole subtrees (attachments included, fully undoable).
- **Tasks** — turn a note into a to-do, set due dates, get reminders.
- **Tiny mode** — pop Stashpad into a small, pinnable, opacity-adjustable window for
quick capture while you work elsewhere.
- **Folder panel** — sidebar of your Stashpad folders and pinned notes/folders.
- **Import / export**`.stash` bundles (optionally encrypted) round-trip notes +
attachments; dropped files auto-import.
- **Authorship / multiplayer** — stamp notes with your name; shared vaults track
contributors, with a vault-wide author registry.
- **Johnny.Decimal index** — build a JD-style hierarchy from dotted-prefix titles.
## Open Knowledge Format (OKF)
[OKF](https://github.com/GoogleCloudPlatform/knowledge-catalog/tree/main/okf) is
Google's open, vendor-neutral spec for packaging curated knowledge as Markdown that
LLMs and agents can read. Stashpad already stores notes as Markdown with frontmatter
and a real hierarchy, so it can produce OKF bundles for you:
- Turn OKF on, then opt **per folder** by assigning the auto-created template.
- Each OKF folder gets complementary `okf*` frontmatter and a generated `index.md`;
your own fields and links are never renamed or removed.
- **Export as OKF** to `.zip` / `.tar.gz` (portable bundles) or `.stash`. On export,
the `okf*` fields are mapped to OKF's standard keys (`type` / `title` / etc.) and
the hierarchy becomes relative-Markdown links, so the bundle is spec-compliant while
the originals are kept for lossless re-import.
See [`docs/okf-guide.md`](docs/okf-guide.md) for a from-scratch walkthrough.
## Encryption (optional, beta)
Stashpad can lock notes/folders into encrypted `.stashenc` files, with archive folders,
encrypted trash, and shared-key collaboration.
> 🔒 **Please read:** the encryption was written by an AI assistant and has **not**
> been human-audited or security-tested. Treat it as a best-effort way to deter a
> casual snoop, **not** a guarantee. Don't rely on it for anything sensitive, and keep
> unencrypted backups. It's optional and off by default.
## Feedback
Bug reports and "this felt weird" notes are very welcome via the repo's Issues.
## License
See [`LICENSE`](LICENSE).
</content>