fix: deprecate symbols as message names (#27)

Author: atheck

README.md

@@ -9,7 +9,6 @@ This library brings the elmish pattern to react.
 - [Basic Usage](#basic-usage)
 - [More about messages](#more-about-messages)
   - [Message parameters](#message-parameters)
-  - [Symbols instead of strings](#symbols-instead-of-strings)
 - [Dispatch commands in the update map or update function](#dispatch-commands-in-the-update-map-or-update-function)
   - [Dispatch a message](#dispatch-a-message)
   - [Call an async function](#call-an-async-function)
@@ -240,44 +239,6 @@ In the **render** method you can add another button to increment the value by 10
 ...
 ```
 
-### Symbols instead of strings
-
-You can also use **Symbols** for the message type instead of strings:
-
-1. Declare a Symbol for the message:
-
-    ```ts
-    const ResetMsg = Symbol("reset");
-    ```
-
-1. Use this Symbol as message name:
-
-    ```ts
-    export type Message =
-        ...
-        | { name: typeof ResetMsg }
-        ...
-    ```
-
-1. Create the convenient function
-
-    ```ts
-    export const Msg = {
-        ...
-        reset: (): Message => ({ name: ResetMsg }),
-        ...
-    }
-    ```
-
-1. Handle the new message in the `update` function:
-
-    ```ts
-    ...
-    case ResetMsg:
-        return [{ value: 0 }];
-    ...
-    ```
-
 ## Dispatch commands in the update map or update function
 
 In addition to modifying the model, you can dispatch new commands here.

installScript.js

@@ -0,0 +1,4 @@
+"use strict";
+
+// eslint-disable-next-line no-console
+console.warn("react-elmish: Symbols for message names are deprecated now and will be removed in the next major version. Please convert all message names into strings.");

package.json

@@ -5,6 +5,7 @@
   "author": "atheck",
   "license": "MIT",
   "scripts": {
+    "install": "node installScript.js",
     "build": "npm run build:types && npm run build:js",
     "build:types": "tsc --emitDeclarationOnly --project ./src",
     "build:js": "babel src --out-dir dist --extensions \".ts,.tsx\" --ignore \"./**/*.spec.ts\",\"./**/*.spec.tsx\" --source-maps inline",