Skip to content

Commit 00fbe00

Browse files
authored
chore: Improve the README (#10028)
1 parent 405a791 commit 00fbe00

1 file changed

Lines changed: 23 additions & 18 deletions

File tree

README.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,49 @@
11
# Blockly
22

3-
Blockly is a library that adds a visual code editor to web and mobile apps. The Blockly editor uses interlocking, graphical blocks to represent code concepts like variables, logical expressions, loops, and more. It allows users to apply programming principles without having to worry about syntax or the intimidation of a blinking cursor on the command line. All code is [free and open source](https://github.com/raspberrypifoundation/blockly/blob/develop/LICENSE).
3+
Blockly is a library that adds a visual code editor to web apps. The Blockly editor uses interlocking, graphical blocks to represent code concepts like variables, logical expressions, loops, and more. It allows users to apply programming principles without having to worry about syntax or the intimidation of a blinking cursor on the command line. All code is [free and open source](https://github.com/raspberrypifoundation/blockly/blob/develop/LICENSE).
44

5-
![Sample](./sample.svg)
5+
![An example program built with Blockly that checks for a game over state](./sample.svg)
66

77
## Getting Started with Blockly
88

9-
Blockly has many resources for learning how to use the library. Start at our [Developers Site](https://developers.google.com/blockly) to read the documentation on how to get started, configure Blockly, and integrate it into your application. The developers site also contains links to:
9+
Blockly has many resources for learning how to use the library. You can [try a live demo](https://raspberrypifoundation.github.io/blockly/packages/blockly/demos/code/index.html) or [visit our developer site](https://docs.blockly.com) to read the documentation on how to get started, configure Blockly, and integrate it into your application. The developer site also contains links to:
1010

11-
- [Getting Started article](https://developers.google.com/blockly/guides/get-started/web)
12-
- [Getting Started codelab](https://blocklycodelabs.dev/codelabs/getting-started/index.html#0)
13-
- [More codelabs](https://blocklycodelabs.dev/)
11+
- [Getting Started article](https://docs.blockly.com/guides/get-started/what-is-blockly/)
12+
- [Getting Started codelab](https://docs.blockly.com/codelabs/getting-started/codelab-overview/)
13+
- [More codelabs](https://docs.blockly.com/codelabs/)
1414
- [Demos and plugins](https://raspberrypifoundation.github.io/blockly-samples/)
1515

16-
Help us focus our development efforts by telling us [what you are doing with Blockly](https://developers.google.com/blockly/registration). The questionnaire only takes a few minutes and will help us better support the Blockly community.
17-
1816
### Installing Blockly
1917

20-
Blockly is [available on npm](https://www.npmjs.com/package/blockly):
18+
If you're starting a new project using Blockly, you can bootstrap it
19+
using our [`create-package` tool](https://www.npmjs.com/package/@blockly/create-package):
2120

2221
```bash
23-
npm install blockly
22+
npx @blockly/create-package app my-cool-blockly-app --typescript
2423
```
2524

26-
For more information on installing and using Blockly, see the [Getting Started article](https://developers.google.com/blockly/guides/get-started/web).
25+
Or, if you're adding Blockly to an existing project, just [install it with npm](https://www.npmjs.com/package/blockly):
26+
27+
```bash
28+
npm install blockly
29+
```
2730

2831
### Getting Help
2932

30-
- [Report a bug](https://developers.google.com/blockly/guides/modify/contribute/write_a_good_issue) or file a feature request on GitHub
33+
- [Report a bug](https://docs.blockly.com/guides/contribute/get-started/write_a_good_issue/) or file a feature request on GitHub
3134
- Ask a question, or search others' questions, on our [developer forum](https://groups.google.com/forum/#!forum/blockly). You can also drop by to say hello and show us your prototypes; collectively we have a lot of experience and can offer hints which will save you time. We actively monitor the forums and typically respond to questions within 2 working days.
3235

3336
### blockly-samples
3437

35-
We have a number of resources such as [examples](https://github.com/raspberrypifoundation/blockly-samples/tree/main/examples), [codelabs](https://github.com/raspberrypifoundation/blockly-samples/tree/main/codelabs), and [plugins](https://github.com/raspberrypifoundation/blockly-samples/tree/main/plugins) in another repository called [blockly-samples](https://github.com/raspberrypifoundation/blockly-samples). A plugin is a self-contained piece of code that adds functionality to Blockly. Plugins can add fields, define themes, create renderers, and much more. For more information, see the [Plugins documentation](https://developers.google.com/blockly/guides/programming/plugin_overview).
38+
We have a number of resources such as [examples](https://github.com/raspberrypifoundation/blockly-samples/tree/main/examples), [codelabs](https://github.com/raspberrypifoundation/blockly-samples/tree/main/codelabs), and [plugins](https://github.com/raspberrypifoundation/blockly-samples/tree/main/plugins) in another repository called [blockly-samples](https://github.com/raspberrypifoundation/blockly-samples). A plugin is a self-contained piece of code that adds functionality to Blockly. Plugins can add fields, define themes, create renderers, and much more. For more information, see the [Plugins documentation](https://docs.blockly.com/guides/programming/plugin_overview/).
3639

3740
## Contributing to Blockly
3841

39-
Want to make Blockly better? We welcome contributions to Blockly in the form of pull requests, bug reports, documentation, answers on the forum, and more! Check out our [Contributing Guidelines](https://developers.google.com/blockly/guides/modify/contributing) for more information. You might also want to look for issues tagged "[Help Wanted](https://github.com/raspberrypifoundation/blockly/labels/help%20wanted)" which are issues we think would be great for external contributors to help with.
42+
Want to make Blockly better? We welcome contributions to Blockly in the form of pull requests, bug reports, documentation, answers on the forum, and more! Check out our [Contributing Guidelines](https://docs.blockly.com/guides/contribute/) for more information. You might also want to look for issues tagged "[Help Wanted](https://github.com/raspberrypifoundation/blockly/labels/help%20wanted)" which are issues we think would be great for external contributors to help with.
4043

4144
## Releases
4245

43-
We release new versions on npm and GitHub releases, and then update our [docs](https://developers.google.com/blockly) and [demo pages](https://raspberrypifoundation.github.io/blockly-samples/). If there are breaking regressions, such as a crash when performing a standard action or a rendering issue that makes Blockly unusable, we will cherry-pick fixes into patch releases. The [releases page](https://github.com/raspberrypifoundation/blockly/releases) has a list of all releases.
46+
We release new versions on npm and GitHub releases, and then update our [docs](https://docs.blockly.com) and [demo pages](https://raspberrypifoundation.github.io/blockly-samples/). If there are breaking regressions, such as a crash when performing a standard action or a rendering issue that makes Blockly unusable, we will cherry-pick fixes into patch releases. The [releases page](https://github.com/raspberrypifoundation/blockly/releases) has a list of all releases.
4447

4548
We use [semantic versioning](https://semver.org/). Releases that have breaking changes or are otherwise not backwards compatible will have a new major version. Patch versions are reserved for bug-fix patches between scheduled releases.
4649

@@ -68,7 +71,9 @@ Unreleased APIs may change radically. Anything that is in `main` but not release
6871

6972
We typically triage all bugs within 1 week, which includes adding any appropriate labels and assigning it to a milestone. Please keep in mind, we are a small team so even feature requests that everyone agrees on may not be prioritized.
7073

71-
## Good to Know
74+
## Accessibility
7275

73-
- Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com)
74-
- We test browsers using [BrowserStack](https://browserstack.com)
76+
Although Blockly is built around drag-and-drop, it is fully usable with the
77+
keyboard alone. Blockly is also accessible to screenreader users by default. We
78+
provide [Accessibility Conformance Reports](https://docs.blockly.com/guides/app-integration/accessibility/compliance/)
79+
in the VPAT format that outline Blockly's conformance to WCAG 2.2 Level AA.

0 commit comments

Comments
 (0)