pelican/README.md
Dan Anglin 83c3d58ec9
chore: project rename and license change
- Changed the name of the project to pelican
- Changed the license to MIT.
2023-04-26 14:41:50 +01:00

18 lines
523 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/canal/canal.db
If $XDG\_DATA\_HOME is not set then the default location is $HOME/.local/share/canal/canal.db by default.
For all other operating systems the default location is $HOME/.canal/canal.db.
## Keybindings
## Inspiration
[The toukan project](https://github.com/witchard/toukan).