Update CHANGELOG and fix README for v2.0.0-beta.1

Author: m-mohr

CHANGELOG.md

@@ -6,22 +6,62 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [2.0.0-beta.1] - 2020-01-31
+## [2.0.0-beta.1] - 2020-01-19
+
+This release contains a large number of changes. It lists only the major changes that may need users to adapt their code. Bug fixes or minor improvements are not listed in detail.
 
 ### Added
+- New components:
+	- `Collections`
+	- `FileFormat`
+	- `Processes`
+	- `SearchableList`
+	- `ServiceType`
+- `Description`: New property `allowHTML` to enable HTML rendering embedded in Markdown files
+- `FileFormats`, `ServiceTypes` and `UdfRuntimes`:
+	- New properties `searchTerm`, `sort`, `allowExpand`, `heading`
+	- Shows a heading by default
+	- Supports searching by default and shows a search box
+	- Expands on click to show details about the file format / service type / UDF runtime
+- `ObjectTree`: New property `collapseAfter` to set the number of array elements or object properties to show by default. This can now be used to show all, too.
+- `SupportedFeatures`: 
+	- New property `heading`
+	- Shows a heading by default
+- `UdfRuntime`: Added slots `title`, `badges` and `before-description`
 
 ### Changed
 - Release components as [Async Web Components](https://cli.vuejs.org/guide/build-targets.html#async-web-component) instead of as Vue Library. [#28](https://github.com/Open-EO/openeo-vue-components/issues/28)
-- `Collection`: Prop renamed from `collectionData` to `collection`
-- `Process`: Prop renamed from `processData` to `process`
-
-### Deprecated
+	- In a Vue environment the components need to be imported directly from the `components` folder.
+	- In an HTML environment the components can be included as HTML tag instead of initializing it as a Vue app.
+- `Capabilities`: Removed properties `serviceTypes`, `fileFormats` and `udfRuntimes`. These are not rendered any longer in the component and the corresponding components need to be rendered manually.
+- `Collection`:
+	- Property renamed from `collectionData` to `collection`.
+	- Leaflet and related dependencies don't need to be included explicitly in the HTML files.
+	- All slots have changed.
+- `DeprecationNotice` and `ExperimentalNotice`: The texts have slightly changed so that the property `entity` is not required any longer.
+- `FileFormats`: Properties `showInput` and `showOutput` have the default value `true`. Beforehand it was `false`.
+- `ObjectTree`: The default number of array elements or object properties to show has been reduced from 50 to 10.
+- `Process`: 
+	- Property renamed from `processData` to `process`.
+	- All slots have changed.
+- `UdfRuntime`:
+	- Properties have been renamed. `runtimeId` to `id`, `runtimeData` to `runtime` and `runtimeVersion` to `version`
 
 ### Removed
-- `EventBusMixin`, use Vue's native `$on` and `$off` methods on the `$root` component instead.
-- `BaseMixin`, not required any longer.
-- `getCount()` methods from `FileFormats`, `LinkList`, `ServiceTypes`, `UdfRuntimes`. Counts will be shown directly in the lists.
-- `getPlanCount()` method from `BillingPlans`.
+- Components don't migrate old API responses automatically any longer, which leads to the following changes:
+	- Dropped support for API version 0.4.
+	- The `version` property that specifies the version number of the given API response has been removed for all components.
+	- The `BaseMixin` is not required any longer.
+- The single entity components can't collapse any longer. The property `initiallyCollapsed` has been removed for all components.
+- `BillingPlans`: Removed method `getPlanCount()`.
+- `EventBusMixin`. Use Vue's native `$on` and `$off` methods on the `$root` component instead.
+- `FileFormats`, `LinkList`, `ServiceTypes`, `UdfRuntimes`: Removed method `getCount()`. Counts will be shown directly in the lists.
+- `SupportedFeatures`: Removed methods `getFeatures`, `getFeatureCount`, `getSupportedFeatureCount`. Counts will be shown directly in the list and features can be imported from the `featurelist.js`.
+
+### Fixed
+- Several minor improvements and bugfixes to the components overall.
+- Better documentation
+
 
 ## [1.0.0] - 2017-06-20
 

README.md

@@ -190,7 +190,7 @@ Visualizes a single supported file format of the back-end.
 
 The properties must be filled with parts of the response for supported file formats as defined by the openEO API (`GET /file_formats`). Returned is an object like `{ input: { GTiff: {...} }, output: { PNG: {...} } }` and some of the keys and values must be passed.
 
-- `id` (object, required): The identifier of the file format (i.e. the key of the second level; `GTiff` or `PNG` in the example above)
+- `id` (string, required): The identifier of the file format (i.e. the key of the second level; `GTiff` or `PNG` in the example above)
 - `format` (object, required): The file format specification (i.e. the value of the second level; `{...}` in the example above)
 - `type` (boolean, required): Either `input` or `output` (i.e. the key of the first level)
 
@@ -250,7 +250,7 @@ Often used as a fallback if no other form of presentation is known by the client
 **Properties:**
 
 - `data` (object): Any object (i.e. object, array or null)
-- `collapseAfter` (integer|null): The number of elements to display for each object or array until a "show all" button is shown. Set to `null` to show all elements.
+- `collapseAfter` (integer|null): The number of elements to display for each object or array until a "show all" button is shown. Set to `null` to show all elements. Defaults to `10`.
 
 
 ### `Process`
@@ -323,7 +323,7 @@ Visualizes a single secondary web service supported by the back-end.
 
 The properties must be filled with parts of the response for supported secondary web services as defined by the openEO API (`GET /service_types`). Returned is an object like `{ WMS: {...}, WFS: {...} }` and one of the keys and values must be passed to the component.
 
-- `id` (object, required): The identifier of the secondary web service (i.e. a key of the object; `WMS` or `WFS` in the example above)
+- `id` (string, required): The identifier of the secondary web service (i.e. a key of the object; `WMS` or `WFS` in the example above)
 - `service` (object, required): The secondary web service specification (i.e. the value for the corresponding key; `{...}` in the example above)
 
 **Slots:**
@@ -533,7 +533,7 @@ Visualizes a single UDF (user-defined function) runtime supported by the back-en
 
 The properties must be filled with parts of the response for supported UDF runtime as defined by the openEO API (`GET /udf_runtimes`). Returned is an object like `{ R: {...}, Python: {...} }` and one of the keys and values must be passed to the component.
 
-- `id` (object, required): The identifier of the UDF runtime (i.e. a key of the object; `R` or `Python` in the example above)
+- `id` (string, required): The identifier of the UDF runtime (i.e. a key of the object; `R` or `Python` in the example above)
 - `runtime` (object, required): The UDF runtime specification (i.e. the value for the corresponding key; `{...}` in the example above)
 - `version` (string|null): If one of the versions or tags available for the runtime should be pre-selected and shown, specify the version or tag here. By default (`null`), the default version or tag specified by the back-end will be shown.