diff --git a/README.md b/README.md index 04d28ce..95a6a69 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,43 @@

-# tagwiki +# Tagwiki -A tag-addressable wiki. +Tagwiki is a wiki in which you link to pages by specifing hashtags they contain. +Example: `/tagwiki/help` link will lead to all pages that contain both `#tagwiki` and `#help`. + +This allows effortless and self-structuring organization and editing experience, +as the page collection grows and evolves. + +### My use-case + +I just need a personal wiki, that I can throw random things into, +that I don't have to pre-plan or carefully maintain. + +### User facing features and design goals + +* browser-based UI, +* uses Markdown for content, +* brutally simple, +* fast, +* excelent support for keyboard navigation, +* keeps pages as markdown files in a directory, + +### Under the hood + +* Rust, `async/await` + +### Feature ideas: + +* "journal mode" - for easy note taking +* support public-facing setups (authentication, permissions, and so on) + +### Installing & running + +Like any Rust program. `cargo install --git https://github.com/dpc/tagwiki`. + +To run `tagwiki ` + +See `docs` directory for more user-documentation. Pages inside it are +tagwiki content, so you can try `tagwiki ./docs` try things out.