diff --git a/README.md b/README.md index 48d3bac..41f5adc 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ marked as Favourite to the disk. ## Configuration There is one single configuration file, `downfav.toml` which is read in the -current directory[^1]. +current directory. The general format of this file is: @@ -74,37 +74,3 @@ And, to use the Filesystem storage, you should have no other configuration. ## License GNU AFFERO GENERAL PUBLIC LICENSE, Version 3. - -## Ideas - -- [ ] Use [clap](https://crates.io/crates/clap) for a full command line - experience. -- [ ] Manage multiple accounts (as in `downfav account add ` and maybe account - and server?); use a single configuration file. -- [ ] Store the configuration file in a fixed path instead of the current - directory. -- [ ] Add configuration for the -- [ ] Manage multiple storages for accounts (as in `downfav storage add - `; if there are any options, they could follow the - storage type and/or ask the user.) -- [ ] Move the Storage trait to the main Storage module. -- [ ] Better error handling in the main loop (currently, if there is an issue, - the "last seen toot" will be still updated); the Storage trait must return - `Result`s; remove the functional/fluent loop in the main application and use - a `for`. -- [ ] Since things can fail, all Storages must take this in account (filesystem - will just override things, so it is no real issue; Joplin must check if the - note already exists; Org must save the note in a temporary file and just move - it in the end). -- [ ] Async? -- [ ] Proper word-wrapping for Markdown and Org Modes (links is pretty hard to - wrap correctly, due the combination of title and link). - ---- - -[^1]: Why in the current directory? If you're using the filesystem storage, - keeping all favourites in a single directory, we need to access the `data` - directory to store things there. By forcing having in the current directory, - we can be somewhat sure it won't keep adding `data` to whatever. Also, it - helps if you have multiple accounts. *On a related note, maybe we could add - multiple accounts and fixed directory in the config file itself.*