Restored CHANGELOG.md, removed GETSTARTED.md, and cleaned up README.md

google · Jul 5, 2023 · e5a71f2 · e5a71f2
1 parent d7cc6e9
commit e5a71f2
Show file tree

Hide file tree

Showing 3 changed files with 288 additions and 42 deletions.
diff --git a/plugins/field-date/CHANGELOG.md b/plugins/field-date/CHANGELOG.md
@@ -0,0 +1,254 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [7.0.0](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-06-28)
+
+
+### ⚠ BREAKING CHANGES
+
+* update all plugins to use blockly-v10.0.0 (#1744)
+
+### Features
+
+* update all plugins to use blockly-v10.0.0 ([#1744](https://github.com/google/blockly-samples/issues/1744)) ([6cc88cb](https://github.com/google/blockly-samples/commit/6cc88cbef39d4ad664a668d3d46eb29ba7292f9c))
+
+
+
+## [6.1.2](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-06-22)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## [6.1.1](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-05-18)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## [6.1.0](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-05-11)
+
+
+### Features
+
+* Add angle, colour, and multiline fields. (Rebase of [#1674](https://github.com/google/blockly-samples/issues/1674)) ([#1693](https://github.com/google/blockly-samples/issues/1693)) ([1b447f4](https://github.com/google/blockly-samples/commit/1b447f41d6293f14e846b8a4d82d289a5637a99a))
+
+
+
+## [6.0.14](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-05-04)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## [6.0.13](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-04-27)
+
+
+### Bug Fixes
+
+* Correct date field test assertions ([#1673](https://github.com/google/blockly-samples/issues/1673)) ([9974e85](https://github.com/google/blockly-samples/commit/9974e85becaa8ad17e35b588b95391c85865dafd))
+
+
+
+## [6.0.12](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-03-23)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## [6.0.11](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-03-09)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## [6.0.10](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-03-02)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## [6.0.9](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-02-23)
+
+
+### Bug Fixes
+
+* remove prepublishOnly scripts ([#1579](https://github.com/google/blockly-samples/issues/1579)) ([27da6cd](https://github.com/google/blockly-samples/commit/27da6cd04c38f6ba417f4e7446bb6218c475448d))
+
+
+
+## [6.0.8](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-02-23)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## [6.0.7](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-02-16)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## [6.0.6](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-02-09)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## [6.0.5](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-01-26)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## [6.0.4](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2023-01-05)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## [6.0.3](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2022-12-15)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## [6.0.2](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2022-10-27)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## [6.0.1](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2022-10-13)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## [6.0.0](https://github.com/google/blockly-samples/compare/@blockly/[email protected]...@blockly/[email protected]) (2022-10-05)
+
+
+### ⚠ BREAKING CHANGES
+
+* update peer and devDependencies of all plugins to require Blockly v9 (#1314)
+* update field-date to es6 class (#1295)
+
+### Bug Fixes
+
+* references to deprecated functions in v9 ([#1313](https://github.com/google/blockly-samples/issues/1313)) ([cb2e679](https://github.com/google/blockly-samples/commit/cb2e67987e0b62a77c26adc660cc6ade1ba67954))
+* update field-date to es6 class ([#1295](https://github.com/google/blockly-samples/issues/1295)) ([9b70b03](https://github.com/google/blockly-samples/commit/9b70b0300c625c0cddc1eea241a3d2c2200344f8))
+
+
+### Miscellaneous Chores
+
+* update peer and devDependencies of all plugins to require Blockly v9 ([#1314](https://github.com/google/blockly-samples/issues/1314)) ([03d4912](https://github.com/google/blockly-samples/commit/03d4912c42c8de0f30493037ccc28dddaea0f266))
+
+
+
+## 5.0.22 (2022-08-11)
+
+
+### Bug Fixes
+
+* Remove the deprecated block-extension-tooltip ([#1215](https://github.com/google/blockly-samples/issues/1215)) ([a044478](https://github.com/google/blockly-samples/commit/a044478c86a73e3065bc866e427f175cbec6fc13))
+
+
+
+
+
+## 5.0.21 (2022-08-04)
+
+
+### Bug Fixes
+
+* fix the name of the package of suggested-blocks ([#1214](https://github.com/google/blockly-samples/issues/1214)) ([35aa8ec](https://github.com/google/blockly-samples/commit/35aa8ec73a60a4eb5b1e80cb2fc71dcd83d05e27))
+
+
+
+
+
+## 5.0.19 (2022-07-21)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## 5.0.18 (2022-07-06)
+
+
+### Bug Fixes
+
+* Update blockly-react to use functional components instead of class components. ([#1178](https://github.com/google/blockly-samples/issues/1178)) ([fa21187](https://github.com/google/blockly-samples/commit/fa21187cdbe4ec3a5c69f185540dd68a98eb69d7))
+
+
+
+
+
+## 5.0.17 (2022-06-27)
+
+
+### Bug Fixes
+
+* Update package import for keyboard navigation demo ([#1170](https://github.com/google/blockly-samples/issues/1170)) ([69c1725](https://github.com/google/blockly-samples/commit/69c1725b775279fcc397dc178935208d5f42b08c))
+
+
+
+
+
+## 5.0.16 (2022-06-21)
+
+**Note:** Version bump only for package @blockly/field-date
+
+
+
+
+
+## 5.0.15 (2022-06-08)
+
+
+### Bug Fixes
+
+* package versions to support patch releases ([#1150](https://github.com/google/blockly-samples/issues/1150)) ([e1ae378](https://github.com/google/blockly-samples/commit/e1ae378d779531621c3d948566257d069002963f))
+
+
+
+
+
+## 5.0.14 (2022-06-02)
+
+
+### Bug Fixes
+
+* add git identity ([#1156](https://github.com/google/blockly-samples/issues/1156)) ([8d80924](https://github.com/google/blockly-samples/commit/8d809243b277375beb2ce75d4e157b5e17f78193))
diff --git a/plugins/field-date/GETSTARTED.md b/plugins/field-date/GETSTARTED.md
diff --git a/plugins/field-date/README.md b/plugins/field-date/README.md
@@ -1,46 +1,62 @@
-# blockly-field-date [![Built on Blockly](https://tinyurl.com/built-on-blockly)](https://github.com/google/blockly)
+# @blockly/field-date [![Built on Blockly](https://tinyurl.com/built-on-blockly)](https://github.com/google/blockly)
 
 <!--
   - TODO: Edit plugin description.
   -->
-A [Blockly](https://www.npmjs.com/package/blockly) plugin that ...
+A [Blockly](https://www.npmjs.com/package/blockly) plugin that uses a browser default "date" input.
 
 ## Installation
 
 ### Yarn
 ```
-yarn add blockly-field-date
+yarn add @blockly/field-date
 ```
 
 ### npm
 ```
-npm install blockly-field-date --save
+npm install @blockly/field-date --save
 ```
 
 ## Usage
 
+### JavaScript
+
 <!--
   - TODO: Update usage.
   -->
 ```js
 import * as Blockly from 'blockly';
-import {Plugin} from 'blockly-field-date';
-
-// Inject Blockly.
-const workspace = Blockly.inject('blocklyDiv', {
-  toolbox: toolboxCategories,
-});
-
-// Initialize plugin.
-const plugin = new Plugin(workspace);
-plugin.init();
+import {FieldDate} from '@blockly/field-date';
+
+Blockly.Blocks["test_fields_date"] = {
+  init: function () {
+    this.appendDummyInput()
+      .appendField("date: ")
+      .appendField(new FieldDate("2020-02-20"), "FIELDNAME");
+  }
+};
 ```
 
-## API
+### JSON
 
-<!--
-  - TODO: describe the API.
-  -->
+```js
+import * as Blockly from 'blockly';
+import '@blockly/field-date';
+
+Blockly.defineBlocksWithJsonArray([
+    {
+        "type": "test_fields_date",
+        "message0": "date: %1",
+        "args0": [
+            {
+                "type": "field_date",
+                "name": "FIELDNAME",
+                "date": "2020-02-20"
+            }
+        ]
+    }]);
+```
+- [View the developer documentation](https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/date) for further usage examples.
 
 ## License
 Apache 2.0