Update readme

Author: aarranz

README.md

@@ -1,5 +1,4 @@
-NGSI Browser widget
-===================
+# NGSI Browser widget
 
 The NGSI Browser widget allows you to browser [Orion Context
 Broker](http://catalogue.fiware.org/enablers/publishsubscribe-context-broker-orion-context-broker)
@@ -43,65 +42,19 @@ grunt
 
 If everything goes well, you will find a wgt file in the `dist` folder.
 
-Settings and Usage
-------------------
-
-### Settings
-
-- **NGSI server URL:** URL of the Orion Context Broker to use for retrieving
-  entity information.
-- **NGSI proxy URL:** URL of the Orion Context Broker proxy to use for receiving
-  notifications about changes.
-- **Use the FIWARE credentials of the user:** Use the FIWARE credentials of the
-  user logged into WireCloud. Take into account this option cannot be enabled if
-  you want to use this widget in a public workspace as anonoymous users doesn't
-  have a valid FIWARE auth token. As an alternative, you can make use of the
-  "Use the FIWARE credentials of the workspace owner" preference.
-- **Use the FIWARE credentials of the dashboard owner**: Use the FIWARE
-  credentials of the owner of the workspace. This preference takes preference
-  over "Use the FIWARE credentials of the user". This feature is available on
-  WireCloud 0.7.0+ in a experimental basis, future versions of WireCloud can
-  change the way to use it making this option not funcional and requiring you to
-  upgrade this operator.
-- **NGSI tenant/service**: Tenant/service to use when connecting to the context
-  broker. Must be a string of alphanumeric characters (lowercase) and the `_`
-  symbol. Maximum length is 50 characters. If empty, the default tenant will be
-  used
-- **NGSI scope**: Scope/path to use when connecting to the context broker. Must
-  be a string of alphanumeric characters (lowercase) and the `_` symbol
-  separated by `/` slashes. Maximum length is 50 characters. If empty, the
-  default service path will be used: `/`
-- **NGSI entity types:** A comma separated list of entity types to use for
-  filtering entities from the Orion Context broker. This field cannot be empty.
-- **Id pattern:** Id pattern for filtering entities. This preference can be
-  empty, in that case, entities won't be filtered by id.
-- **Extra Attributes:** Comma separated list of attributes to be displayed in
-  the widget as extra columns.
-
-### Wiring
-
-##### Input Endpoints
-
-* This widget has no input endpoint
-
-##### Output Endpoints
-
--   **Selection:** This widget sends an event thought this endpoint when the
-    user clicks on the "Use Button". Entities using this operator uses the flat
-    option of the WireCloud API. Event data example:
-
-    ```json
-    {
-        "id": "van4",
-        "type": "Van",
-        "current_position": "43.47173, -3.7967205"
-    }
-    ```
-
-Copyright and License
----------------------
-
-Copyright (c) 2015 CoNWeT Lab., Universidad Politecnica de Madrid
+
+## Documentation
+
+Documentation about how to use this widget is available on the
+[User Guide](src/doc/userguide.md). Anyway, you can find general information
+about how to use widgets on the
+[WireCloud's User Guide](https://wirecloud.readthedocs.io/en/stable/user_guide/)
+available on Read the Docs.
+
+
+## Copyright and License
+
+Copyright (c) 2016 CoNWeT Lab., Universidad Politecnica de Madrid
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

src/config.xml

@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<widget xmlns="http://wirecloud.conwet.fi.upm.es/ns/macdescription/1" vendor="CoNWeT" name="ngsi-browser" version="1.0.2">
+<widget xmlns="http://wirecloud.conwet.fi.upm.es/ns/macdescription/1" vendor="CoNWeT" name="ngsi-browser" version="1.1.0">
     <details>
         <title>NGSI browser</title>
         <email>wirecloud@conwet.com</email>

src/doc/changelog.md

@@ -1,7 +1,8 @@
-## v1.1.0
+## v1.1.0 (2016-12-12)
 
-- Add support for editing entities
-- Add support for creating new entities
+- Added initial support for editing entities
+- Added initial support for creating new entities
+- Based on `json-editor` v1.0
 
 ## v1.0.2
 

src/js/main.js

@@ -90,7 +90,7 @@
         this.add_entity_button.addEventListener('click', function (button) {
             openEditorWidget.call(this, button);
             this.editor_config_output.pushEvent({
-                "blacklist": []
+                "readonly": []
             });
             this.template_output.pushEvent('{"id": "", "type": ""}');
         }.bind(this));
@@ -284,7 +284,7 @@
                         button.addEventListener('click', function (button) {
                             openEditorWidget.call(this, button);
                             this.editor_config_output.pushEvent({
-                                "blacklist": [
+                                "readonly": [
                                     ["id"],
                                     ["type"],
                                 ]