Documentation suggestions

[iconoclasthero]

In our discord discussion, 2024-09-29, I mentioned that

[6:31 AM]iconoclast hero: documentation could use some fleshing out though.
[6:36 AM]iconoclast hero: https://github.com/waycrate/swhkd?tab=readme-ov-file#configuration
[6:38 AM]iconoclast hero:
swhkd closely follows sxhkd syntax, so most existing sxhkd configs should be functional with swhkd.

How about a link to the syntax or a link to the man page for it? I don't have any idea what sxhkd is or what it's syntax is and nowhere (in the online documentation) do you show what that is. apparently you expect the man pages to do the heavy lifting on that (? —or expect that the user already has familiariarity with sxhkd), except that nowhere do you say that. (The clue I found was 'All supported key and modifier names are listed in man 5 swhkd-keys.`) (edited)
[6:39 AM]iconoclast hero: A link to sxhkd's syntax would also work here.

and your response was...

Okay I get where you're coming from, and that makes sense. We assumed the users are familiar with sxhkd but here's how things work:

Create a sample entry in ~/.config/swhkd/swhkdrc

Eg

super + return
alacritty

And then simply run the two binaries as shown in readme.

Hit the keybind specified and things should just work.

[iconoclasthero]

Not sure if this works as a discord bookmark:
https://discord.com/channels/925817758334201937/925817758334201940/1289915870713348218

[Aditya-PS-05]

@iconoclasthero , can you assign me this issue?