scratchblocks-plus 1.0.2 → 1.1.0

package/README.md

@@ -7,13 +7,28 @@ Make pictures of Scratch blocks from text.
 
 **[Try it out!](https://luyifei2011.github.io/scratchblocks-plus/)**
 
+[Documentation](https://luyifei2011.github.io/scratchblocks-plus-docs/)
+
 ---
 
 **scratchblocks-plus** is a fork of **scratchblocks**, and adds the following features:
 
-- basic TypeScript support
-- Matrix support (issue: [scratchblocks#509](https://github.com/scratchblocks/scratchblocks/issues/509), PR: [scratchblocks#573](https://github.com/scratchblocks/scratchblocks/pull/573))
+- matrix support
+  - [try it out!](https://luyifei2011.github.io/scratchblocks-plus/#?style=scratch3&script=display%20(%7B01010%2C%0A%20%20%20%20%20%20%20%20%20%2010101%2C%0A%20%20%20%20%20%20%20%20%20%2010001%2C%0A%20%20%20%20%20%20%20%20%20%2001010%2C%0A%20%20%20%20%20%20%20%20%20%2000100%7D%20v))
+  - issue: [scratchblocks#509](https://github.com/scratchblocks/scratchblocks/issues/509)
+  - PR: [scratchblocks#573](https://github.com/scratchblocks/scratchblocks/pull/573)
 - block highlight
+  - [example 1](https://luyifei2011.github.io/scratchblocks-plus/example/text-highlight.html)
+  - [example 2](https://luyifei2011.github.io/scratchblocks-plus/example/speech-highlight.html)
+- dropdown menu translate
+  - [try it out!](https://luyifei2011.github.io/scratchblocks-plus/translator/#?lang=zh_cn&script=go%20to%20(mouse-pointer%20v))
+  - issue: [scratchblocks#324](https://github.com/scratchblocks/scratchblocks/issues/324)
+  - PR: [scratchblocks#556](https://github.com/scratchblocks/scratchblocks/pull/556)
+- server-side rendering
+  - issue: [scratchblocks#402](https://github.com/scratchblocks/scratchblocks/issues/402)
+  - PR: [scratchblocks#589](https://github.com/scratchblocks/scratchblocks/pull/589)
+- basic TypeScript support
+- and more!
 
 **scratchblocks-plus** is compatible with **scratchblocks**, so you can use it as a drop-in replacement.
 
@@ -46,7 +61,7 @@ It uses the [pandoc_scratchblocks](https://github.com/CodeClub/pandoc_scratchblo
 This would probably be a good way to write a Scratch book.
 -->
 
-# React
+## React
 
 Use the [scratchblocks-plus-react](https://github.com/LuYifei2011/scratchblocks-plus-react) package to render scratchblocks in React.
 
@@ -125,7 +140,7 @@ The translations files are hundreds of kilobytes in size, so to keep your page b
 For example, a translations file that just loads the German language (ISO code `de`) would look something like this:
 
 ```js
-window.scratchblocks.loadLanguages({
+scratchblocks.loadLanguages({
     de: <contents of locales/de.json>
 })
 ```
@@ -134,7 +149,7 @@ If you're using a JavaScript bundler you should be able to build your own transl
 This requires your bundler to allow importing JSON files as JavaScript.
 
 ```js
-window.scratchblocks.loadLanguages({
+scratchblocks.loadLanguages({
     de: require('scratchblocks/locales/de.json'),
 })
 ```
@@ -154,7 +169,7 @@ scratchblocks.renderMatching('pre.blocks');
 
 ## ESM Support
 
-Since version 3.6.0, scratchblocks-plus can be properly loaded as an ESM module. The ESM version, instead of defining `window.scratchblocks`, default-exports the `scratchblocks` object. Similarly, the JavaScript translation files default-exports a function to load the translations.
+scratchblocks-plus can be properly loaded as an ESM module. The ESM version, instead of defining `window.scratchblocks`, default-exports the `scratchblocks` object. Similarly, the JavaScript translation files default-exports a function to load the translations.
 
 ```js
 import scratchblocks from "./scratchblocks-plus-es-min.js";
@@ -189,19 +204,19 @@ npm start
 
 Then open <http://localhost:8000/> :-)
 
-For more details, see [`CONTRIBUTING.md`](https://github.com/LuYifei2011/scratchblocks-plus/blob/master/.github/CONTRIBUTING.md).
+For more details, see [`CONTRIBUTING.md`](https://github.com/LuYifei2011/scratchblocks-plus/blob/main/.github/CONTRIBUTING.md).
 
 # Credits
 
 Many, many thanks to the [contributors](https://github.com/LuYifei2011/scratchblocks-plus/graphs/contributors)!
 
-- Authored by [LuYifei2011](https://github.com/LuYifei2011)
+- Maintained by [LuYifei2011](https://github.com/LuYifei2011)
 - This is a fork of [scratchblocks](https://github.com/scratchblocks/scratchblocks), so all the credit there still applies here.
 - Original scratchblocks library by [tjvr](https://github.com/tjvr)
 - Original scratchblocks library maintained by tjvr and [apple502j](https://github.com/apple502j)
 - Icons derived from [Scratch Blocks](https://github.com/scratchfoundation/scratch-blocks) (Apache License 2.0)
 - Scratch 2 SVG proof-of-concept, shapes & filters by [as-com](https://github.com/as-com)
-- Anna helped with a formula, and pointed out that I can't read graphs
+- Anna helped with a formula, and pointed out that tjvr can't read graphs
 - JSO designed the syntax and wrote the original [Block Plugin](https://en.scratch-wiki.info/wiki/Block_Plugin_\(1.4\))
 - Help with translation code from [joooni](https://scratch.mit.edu/users/joooni/)
 - Block translations from the [scratch-l10n repository](https://github.com/scratchfoundation/scratch-l10n/)