Skip to content

Commit 9ae2e37

Browse files
authored
fix: update readme (#574)
1 parent 11ae09a commit 9ae2e37

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# Blockly Keyboard Experimentation
1+
# @blockly/keyboard-navigation
22

3-
This plugin for Blockly enables keyboard navigation. It is intended to
4-
experiment with different actions that might help visually impaired and motor
3+
This plugin for Blockly enables keyboard navigation. It includes
4+
different actions that might help visually impaired and motor
55
impaired people navigate a Blockly workspace.
66

77
Keyboard navigation and screenreader support are closely coupled. The Blockly
8-
team intends to add screenreader support incrementally in Q2 and Q3 of 2025,
8+
team intends to add screenreader support incrementally in Q3 of 2025,
99
as we validate the general approach to navigation.
1010

11-
For more planning and timeline information please read the [January 29 timeline post
12-
on the wiki](https://github.com/google/blockly-keyboard-experimentation/wiki/Jan-29-Timeline).
11+
For more planning and timeline information please see our
12+
[accessibility site](https://developers.google.com/blockly/accessibility).
1313

1414
## End-user instructions
1515

@@ -33,8 +33,8 @@ highlighted. Just like the workspace, you can use the arrow keys to move around
3333
the toolbox and select a block. Pressing `Enter` will place the block at the
3434
cursor's location on the workspace.
3535

36-
If you don't know which actions are available at your cursor location, you
37-
can press `Ctrl + Enter` to open the context menu and see a list of actions.
36+
If you don't know which actions are available, you
37+
can press `/` to see a list of actions.
3838

3939
### Giving feedback
4040

@@ -43,26 +43,24 @@ on this repository! Include information about how to reproduce the bug, what
4343
the bad behaviour was, and what you expected it to do. The Blockly team will
4444
triage the bug and add it to the roadmap.
4545

46-
### Note on @blockly/keyboard-navigation plugin
47-
48-
There is also an [existing keyboard navigation plugin](https://www.npmjs.com/package/@blockly/keyboard-navigation). That plugin may be where
49-
a finalized version of keyboard navigation eventually lives. But for now, this
50-
is where experimentation will be done.
51-
5246
## Testing in your app
5347

5448
### Installation
5549

50+
Using this plugin requires using at least Blockly v12.1.0. You can find the
51+
current minimum required version of Blockly in the `peerDependencies`
52+
section of the `package.json` file for the plugin.
53+
5654
#### Yarn
5755

5856
```
59-
yarn add @blockly/keyboard-experiment
57+
yarn add @blockly/keyboard-navigation
6058
```
6159

6260
#### npm
6361

6462
```
65-
npm install @blockly/keyboard-experiment --save
63+
npm install @blockly/keyboard-navigation --save
6664
```
6765

6866
### Usage

0 commit comments

Comments
 (0)