Skip to content

Commit

Permalink
Update Readme.md with backend statuses & more bookmark add examples
Browse files Browse the repository at this point in the history
  • Loading branch information
sydhds committed Oct 11, 2024
1 parent f72800f commit 4e93212
Showing 1 changed file with 25 additions and 7 deletions.
32 changes: 25 additions & 7 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,22 @@

A Rust-written cli tool for [Floccus](www.floccus.org)

# Status
## Status

Early development (use it with care)
* [Backend]
* Git
* [TODO] Google Drive
* [TODO] Nextcloud

# TODO
### Backend Git - Status

* [DONE] Read / Print bookmarks sync with git
* [WIP] Add a new bookmark
* [EXPERIMENTAL] Add a new bookmark
* [TODO] Rm/Find bookmark
* [TODO] Config file
* [TODO] CI

# Howto use it
## Howto

* cargo build
* ./target/debug/floccus_cli --help
Expand All @@ -23,6 +29,18 @@ Print bookmarks:
* After:
* ./target/debug/floccus-cli print

Add a new bookmark (WIP):
* ./target/debug/floccus-cli add -b https://example.com -t "Example www site"
Add a new bookmark (EXPERIMENTAL, Default: append to root):
* ./target/debug/floccus-cli add -b https://example.com -t "Example www site" --disable-push


* Add a bookmark after a given id (folder or bookmark)
* ./target/debug/floccus-cli add -b https://example.com -t "Example www site" -u after=3 --disable-push
* Add a bookmark in a given folder id (append)
* ./target/debug/floccus-cli add -b https://example.com -t "Example www site" -u 2 --disable-push
* ./target/debug/floccus-cli add -b https://example.com -t "Example www site" -u append=2 --disable-push
* Add a bookmark in a given folder id (prepend)
* ./target/debug/floccus-cli add -b https://example.com -t "Example www site" -u prepend=2 --disable-push

Note:
* Pushing (git push) by floccus-cli is experimental - for now use --disable-push && push manually

0 comments on commit 4e93212

Please sign in to comment.