README notes

Author: jackfranklin

README.md

@@ -2,6 +2,8 @@
 
 A small JavaScript package to let you wrap your Elm applications up in a web component.
 
+## NOTE: this documentation is for v0.7.0-beta, which supports V1 of the Web Elements spec. If you still need V0, please [check the docs for 0.6.1](https://github.com/thread/elm-web-components/tree/0.6.1)
+
 ## Install
 
 ```
@@ -10,7 +12,7 @@ yarn add @teamthread/elm-web-components
 
 ## Configuration (new in 0.6.0)
 
-We support both Elm 0.18 and 0.19 for now. You must configure the module so it knows which one to support:
+We support both Elm 0.18 and 0.19. You must configure the module so it knows which one to support:
 
 ```js
 elmWebComponents.configure('0.18')
@@ -28,6 +30,7 @@ Given the following Elm app:
 module Main exposing (..)
 
 import Html exposing (text, Html)
+import Browser
 
 type Msg
     = NoOp
@@ -57,7 +60,7 @@ init flags =
 
 main : Program Flags Model Msg
 main =
-    Html.programWithFlags
+    Browser.element
         { init = init, update = update, subscriptions = \_ -> Sub.none, view = view }
 ```
 
@@ -76,7 +79,7 @@ And now in your HTML you can use the component:
 <demo-elm-component name="Jack"></demo-elm-component>
 ```
 
-Any attributes are passed into your Elm app as Flags, so make sure you use `programWithFlags` if you care about them. If you don't you can just use `Html.program` as you would normally.
+Any attributes are passed into your Elm app as Flags.
 
 ## Ports
 
@@ -158,3 +161,12 @@ This is useful for tidying up any event listeners you might have.
 ## Examples
 
 You can find full examples in the `example` directory. If you have cloned the repository, you can run `yarn run example` to run them locally.
+
+## Polyfilling for older browsers
+
+elm-web-components does not ship with any polyfills. You should ensure the following functions are available in all browsers you support:
+
+* `Object.assign`
+* `Object.keys`
+
+And additionally ensure that you've included a polyfill for custom elements. We recommend [document-register-element](https://github.com/WebReflection/document-register-element).

package.json

@@ -28,7 +28,6 @@
     "@babel/preset-env": "^7.3.1",
     "babel-loader": "^8.0.5",
     "core-js": "^2.6.4",
-    "document-register-element": "^1.13.1",
     "elm-format": "^0.8.0",
     "prettier": "1.10.2",
     "webpack": "^4.17.1",

yarn.lock

@@ -1814,13 +1814,6 @@ dns-txt@^2.0.2:
   dependencies:
     buffer-indexof "^1.0.0"
 
-document-register-element@^1.13.1:
-  version "1.13.1"
-  resolved "https://registry.yarnpkg.com/document-register-element/-/document-register-element-1.13.1.tgz#dad8cb7be38e04ee3f56842e6cf81af46c1249ba"
-  integrity sha512-92ZyLDKg9j4rOll//NNXj25f+8rAzOkYsGJonhugKwXfeqH7bzs8Ucpvey0WzZ2ZzKdrvW9RnUw3UyOZ/uhBFw==
-  dependencies:
-    lightercollective "^0.1.0"
-
 domain-browser@^1.1.1:
   version "1.1.7"
   resolved "https://registry.yarnpkg.com/domain-browser/-/domain-browser-1.1.7.tgz#867aa4b093faa05f1de08c06f4d7b21fdf8698bc"
@@ -2994,11 +2987,6 @@ lcid@^2.0.0:
   dependencies:
     invert-kv "^2.0.0"
 
-lightercollective@^0.1.0:
-  version "0.1.0"
-  resolved "https://registry.yarnpkg.com/lightercollective/-/lightercollective-0.1.0.tgz#70df102c530dcb8d0ccabfe6175a8d00d5f61300"
-  integrity sha512-J9tg5uraYoQKaWbmrzDDexbG6hHnMcWS1qLYgJSWE+mpA3U5OCSeMUhb+K55otgZJ34oFdR0ECvdIb3xuO5JOQ==
-
 loader-runner@^2.3.0:
   version "2.3.0"
   resolved "https://registry.yarnpkg.com/loader-runner/-/loader-runner-2.3.0.tgz#f482aea82d543e07921700d5a46ef26fdac6b8a2"