Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update hotkey README to document hotkey string format #62

Merged
merged 7 commits into from
Dec 16, 2021

Conversation

theinterned
Copy link
Contributor

@theinterned theinterned commented Dec 15, 2021

This PR adds a more detailed section documenting the hotkey string grammar. It also does a few other things:

  1. Adds a simple example of usage at the very top as a TLDR
  2. Swaps the order of the "Basic" usage (HTML and JS) and the more advanced topics like hotkey string format and accessibility.
  3. links to the Hotkey Mapper tool.
  4. Fixes a responsive layout issue in the Hotkey Mapper tool.

You can see the updated README here https://github.com/github/hotkey/blob/41c95f103f6e61e47ec43a83bae8edb30bc980e9/README.md

@theinterned theinterned requested a review from a team as a code owner December 15, 2021 23:42
Puts basic HTML and JS usage at the top / moves Hotkey string format, Accessibilirty and Development further down
README.md Show resolved Hide resolved
@theinterned theinterned merged commit f5d53b2 into main Dec 16, 2021
@theinterned theinterned deleted the theinterned/document_hotkey-string-format branch December 16, 2021 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants