Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jessepav committed May 31, 2024
1 parent 7817907 commit 79e9fe8
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,18 @@ active text section.
the app itself. The first time the app is loaded, it will provide instructions
for entering your own text.

Alternately, you can add a `story=URL` search parameter when you load the page,
and the story will be populated from that URL. Ex:

https://guidedtyping.com/?story=https://mydomain.com/docs/story.md

## Keyboard Layouts

The app supports changing keyboard layouts at runtime, though currently I only
have a definition written for `US_QWERTY`.

The `DisplayKeyboard` web component in
[`js/display-keyboard.mjs`](https://github.com/jessepav/guided-typing/blob/master/js/display-keyboard.mjs)
supports adding keyboard layouts at runtime, though currently I only have a
definition written for `US_QWERTY`. I'm happy to merge PRs for alternate
layouts.
already has the infrastructure in place to (relatively) easily add new layouts
for Latin-script keyboards, and I'm happy to merge PRs. Take a look at the
`US_QWERTY_DEF` layout for a sample and documentation.

0 comments on commit 79e9fe8

Please sign in to comment.