pelican/README.md
Dan Anglin c336fcd82b
feat: add database functions
Add database functions to read and write statuses to the status bucket
in a BoltDB database.

Add database functions to read and write cards to the card bucket.

Use encoding/gob to encode the Status and Card values before writing
them to the database.
2021-08-16 01:56:56 +01:00

18 lines
535 B
Markdown

# Pelican
## Summary
Pelican is a simple Kanban board for your terminal.
## Storage
Data is stored in a [BoltDB](https://github.com/etcd-io/bbolt) database.
For Linux the default the database file is located at $XDG\_DATA\_HOME/pelican/pelican.db
If $XDG\_DATA\_HOME is not set then the default location is $HOME/.local/share/pelican/pelican.db by default.
For all other operating systems the default location is $HOME/.pelican/pelican.db.
## Keybindings
## Inspiration
[The toukan project](https://github.com/witchard/toukan).