naglfar / krunner-keepassxc

A small krunner plugin to copy keepassxc entries to clipboard using its Freedesktop.org Secret Service dbus integration.
MIT License
27 stars 3 forks source link

[Instructions] Add Usage Instructions to README and KDE Store #10

Closed bugzy closed 2 years ago

bugzy commented 2 years ago

How would you feel about adding/updating usage instructions to the git repo readme and to the KDE store? Below are instructions adapted from a comment by nathanu on the kde store page and your current description on the store

Description:

This plugin let's you look up your KeepassXC entries and copy the passwords (and usernames as secondary action) to the system clipboard. It also comes with a small CLI tool to query that information manually.

Requirements:

Enable Secret Service in KeepassXC:

Usage Instructions:

Other Information:

As this is a python application communicating with krunner through D-Bus it needs to be running constantly, for this purpose the install script will place the executable at ~/.local/bin/krunner-keepassxc (you can run this for the CLI) and place a systemd unit file at ~/.config/systemd/user/ to control it. If you're not using systemd a KDE autostart script will be created instead.

More info and alternative installation methods here https://github.com/naglfar/krunner-keepassxc/blob/master/README.md

naglfar commented 2 years ago

Updated readme and kde store description, thanks for the input