Skip to content

Commit 1adfb1b

Browse files
author
kencx
committed
chore: Specify additional json export and config format
1 parent ccd4d31 commit 1adfb1b

3 files changed

Lines changed: 8 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ usage: keyb [options] <command>
6868
6969
Options:
7070
-p, --print Print to stdout
71-
-e, --export Export to file
71+
-e, --export Export to file [yaml, json]
7272
-k, --key Key bindings at custom path
7373
-c, --config Config file at custom path
7474
-v, --version Version info
@@ -99,8 +99,9 @@ $ keyb -p | rofi -dmenu
9999

100100
### keyb File
101101

102-
keyb requires a `yaml` file with a list of hotkeys to work. A default file is
103-
generated in your system's config directory if no other file is specified.
102+
keyb requires a `yaml` or `json` file with a list of hotkeys to work. A default
103+
`yaml` file is generated in your system's config directory if no other file is
104+
specified.
104105

105106
Hotkeys are classified into sections with a name and (optional) prefix field.
106107
When displayed, sections are sorted by alphabetical order while the keys
@@ -170,7 +171,7 @@ If you're missing colors, a workaround is to add the environment variable `CLICO
170171

171172
- [x] Ability to customize keyb hotkeys
172173
- [x] `a, add` subcommand to quickly add a single hotkey entry from the CLI
173-
- [x] Export to additional file formats (`json, toml, conf/ini` etc.)
174+
- [ ] Export to additional file formats (`json, toml, conf/ini` etc.)
174175
- [ ] Support multiple keyb files or directories
175176

176177
## Contributing

examples/config/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ defined as such:
1414
- MacOS/Darwin: `$HOME/Library/Application Support/keyb/`,
1515
- Windows: `%Appdata%\keyb\`
1616

17+
**Note**: `*.json` files are also supported.
18+
1719
## Options
1820

1921
| Option | Default | Description |

main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ const (
1717
1818
Options:
1919
-p, --print Print to stdout
20-
-e, --export Export to file
20+
-e, --export Export to file [yaml, json]
2121
-k, --key Key bindings at custom path
2222
-c, --config Config file at custom path
2323
-v, --version Version info

0 commit comments

Comments
 (0)