Skip to content

Commit

Permalink
fix readme typos
Browse files Browse the repository at this point in the history
  • Loading branch information
durka committed Mar 16, 2018
1 parent 5e4a389 commit ed0bdee
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "karaconv"
version = "0.2.2"
authors = ["Alex Burka <[email protected]>"]
version = "0.3.0"
authors = ["Alex Burka <[email protected]>"]

description = "Converter from Karabiner to Karabiner-Elements configuration format"
categories = ["command-line-utilities"]
Expand All @@ -27,4 +27,7 @@ structopt = "0.2.5"

[dev-dependencies]
tempdir = "0.3.6"
# non-rust testing dependencies:
# - jq >= 1.5 (github stedolan/jq)
# - diff (the unix utility)

6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ This program converts configuration files from Karabiner (`private.xml`) to Kara

Caveats:

- The format of `private.xml` is documented, but it is sometimes vague or inconsistent
- The format of `karabiner.json` is completely undocumented
- Taking the above two points under consideration, I wrote this tool by looking at the docs, my own configuration, and guessing, and I stopped when it was powerful enough to parse my own `private.xml`. It doesn't support the entire format.
- The format of `private.xml` is documented, but it is sometimes vague or inconsistent
- The format of `karabiner.json` is completely undocumented
- Taking the above two points under consideration, I wrote this tool by looking at the docs, my own configuration, and guessing, and I stopped when it was powerful enough to parse my own `private.xml`. It doesn't support the entire format.

If you try `karaconv` and it can't parse your `private.xml`, please post an issue (or pull request)!

Expand Down

0 comments on commit ed0bdee

Please sign in to comment.