Add better README

This commit is contained in:
Dawid Ciężarkiewicz 2020-05-13 00:26:10 -07:00
parent 723d752bc0
commit 46d80728c4
1 changed files with 38 additions and 2 deletions

View File

@ -15,7 +15,43 @@
</p>
# 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 <markdown_files_directory>`
See `docs` directory for more user-documentation. Pages inside it are
tagwiki content, so you can try `tagwiki ./docs` try things out.