docs: add alpha library warning (#72)

mall changes to docs.

Add warning since this library is not yet ready for general use.

@remirror/core/package.json

@@ -10,7 +10,7 @@
     "@types/memoize-one": "4.1.1",
     "@types/nanoevents": "1.0.0",
     "@types/nanoid": "1.2.1",
-    "@types/node": "^11.12.2",
+    "@types/node": "^11.13.0",
     "@types/prosemirror-commands": "^1.0.1",
     "@types/prosemirror-inputrules": "^1.0.2",
     "@types/prosemirror-keymap": "^1.0.1",

packages/jest-prosemirror/package.json

@@ -14,9 +14,9 @@
     "@types/prosemirror-test-builder": "^1.0.1",
     "@types/prosemirror-view": "^1.3.1",
     "chalk": "2.4.2",
-    "jest-diff": "^24.5.0",
-    "jest-matcher-utils": "^24.5.0",
-    "jest-snapshot": "^24.5.0",
+    "jest-diff": "^24.6.0",
+    "jest-matcher-utils": "^24.6.0",
+    "jest-snapshot": "^24.6.0",
     "prosemirror-inputrules": "^1.0.1",
     "prosemirror-model": "^1.7.0",
     "prosemirror-schema-basic": "^1.0.0",

readme.md

@@ -9,7 +9,7 @@
 </div>
 
 <p align="center"><a href="https://dev.azure.com/remirror/remirror/_build/latest?definitionId=1&amp;branchName=master"><img src="https://img.shields.io/azure-devops/build/remirror/1b12c364-8c17-4f7a-a215-b8e0d2c9b253/1.svg?label=Azure%20Pipeline&amp;style=for-the-badge&amp;logo=azuredevops" alt="Azure DevOps builds" /></a>&nbsp;&nbsp;<a href="https://travis-ci.com/ifiokjr/remirror"><img src="https://img.shields.io/travis/com/ifiokjr/remirror.svg?label=Travis%20Build&amp;style=for-the-badge&amp;logo=travis" alt="Travis (.com)" /></a>
-<a href="https://codeclimate.com/github/ifiokjr/remirror/maintainability"><img src="https://img.shields.io/codeclimate/maintainability/ifiokjr/remirror.svg?style=for-the-badge&amp;&amp;logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDI0IDI0Ij48dGl0bGU+Q29kZSBDbGltYXRlIGljb248L3RpdGxlPjxwYXRoIGQ9Ik0gMTYuMDQ2ODc1IDUuMDM5MDYyIEwgMjQgMTIuOTkyMTg4IEwgMjEuMjkyOTY5IDE1LjcwMzEyNSBMIDE2LjA0Njg3NSAxMC40NTcwMzEgTCAxNC4yMDMxMjUgMTIuMzA4NTk0IEwgMTEuNDg4MjgxIDkuNTk3NjU2IFogTSAxMC42NTIzNDQgMTAuNDM3NSBMIDEzLjM1OTM3NSAxMy4xNTIzNDQgTCAxNS45MDYyNSAxNS42OTE0MDYgTCAxMy4xOTE0MDYgMTguMzk4NDM4IEwgNy45NTMxMjUgMTMuMTYwMTU2IEwgMy43NzczNDQgMTcuMzM1OTM4IEwgMi43MDcwMzEgMTguMzk4NDM4IEwgMCAxNS42OTE0MDYgTCA3Ljk1MzEyNSA3LjczODI4MSBaIE0gMTAuNjUyMzQ0IDEwLjQzNzUgIi8+PC9zdmc+" alt="Code Climate maintainability" /></a>&nbsp;&nbsp;<a href="https://codeclimate.com/github/ifiokjr/remirror/issues"><img src="https://img.shields.io/codeclimate/tech-debt/ifiokjr/remirror.svg?style=for-the-badge&amp;&amp;logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDI0IDI0Ij48dGl0bGU+Q29kZSBDbGltYXRlIGljb248L3RpdGxlPjxwYXRoIGQ9Ik0gMTYuMDQ2ODc1IDUuMDM5MDYyIEwgMjQgMTIuOTkyMTg4IEwgMjEuMjkyOTY5IDE1LjcwMzEyNSBMIDE2LjA0Njg3NSAxMC40NTcwMzEgTCAxNC4yMDMxMjUgMTIuMzA4NTk0IEwgMTEuNDg4MjgxIDkuNTk3NjU2IFogTSAxMC42NTIzNDQgMTAuNDM3NSBMIDEzLjM1OTM3NSAxMy4xNTIzNDQgTCAxNS45MDYyNSAxNS42OTE0MDYgTCAxMy4xOTE0MDYgMTguMzk4NDM4IEwgNy45NTMxMjUgMTMuMTYwMTU2IEwgMy43NzczNDQgMTcuMzM1OTM4IEwgMi43MDcwMzEgMTguMzk4NDM4IEwgMCAxNS42OTE0MDYgTCA3Ljk1MzEyNSA3LjczODI4MSBaIE0gMTAuNjUyMzQ0IDEwLjQzNzUgIi8+PC9zdmc+" alt="Code Climate technical debt" /></a>&nbsp;&nbsp;<a href="https://lgtm.com/projects/g/ifiokjr/remirror/alerts/"><img src="https://img.shields.io/lgtm/alerts/g/ifiokjr/remirror.svg?style=for-the-badge&amp;logo=lgtm" alt="LGTM Alerts" /></a>&nbsp;&nbsp;<a href="https://lgtm.com/projects/g/ifiokjr/remirror/context:javascript"><img src="https://img.shields.io/lgtm/grade/javascript/g/ifiokjr/remirror.svg?style=for-the-badge&amp;logo=lgtm" alt="LGTM Grade" /></a>
+<a href="https://codeclimate.com/github/ifiokjr/remirror/maintainability"><img src="https://img.shields.io/codeclimate/maintainability/ifiokjr/remirror.svg?style=for-the-badge&amp;&amp;logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDI0IDI0Ij48dGl0bGU+Q29kZSBDbGltYXRlIGljb248L3RpdGxlPjxwYXRoIGQ9Ik0gMTYuMDQ2ODc1IDUuMDM5MDYyIEwgMjQgMTIuOTkyMTg4IEwgMjEuMjkyOTY5IDE1LjcwMzEyNSBMIDE2LjA0Njg3NSAxMC40NTcwMzEgTCAxNC4yMDMxMjUgMTIuMzA4NTk0IEwgMTEuNDg4MjgxIDkuNTk3NjU2IFogTSAxMC42NTIzNDQgMTAuNDM3NSBMIDEzLjM1OTM3NSAxMy4xNTIzNDQgTCAxNS45MDYyNSAxNS42OTE0MDYgTCAxMy4xOTE0MDYgMTguMzk4NDM4IEwgNy45NTMxMjUgMTMuMTYwMTU2IEwgMy43NzczNDQgMTcuMzM1OTM4IEwgMi43MDcwMzEgMTguMzk4NDM4IEwgMCAxNS42OTE0MDYgTCA3Ljk1MzEyNSA3LjczODI4MSBaIE0gMTAuNjUyMzQ0IDEwLjQzNzUgIi8+PC9zdmc+" alt="Code Climate maintainability" /></a>&nbsp;&nbsp;<a href="https://codeclimate.com/github/ifiokjr/remirror/issues"><img src="https://img.shields.io/codeclimate/tech-debt/ifiokjr/remirror.svg?style=for-the-badge&amp;&amp;logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDI0IDI0Ij48dGl0bGU+Q29kZSBDbGltYXRlIGljb248L3RpdGxlPjxwYXRoIGQ9Ik0gMTYuMDQ2ODc1IDUuMDM5MDYyIEwgMjQgMTIuOTkyMTg4IEwgMjEuMjkyOTY5IDE1LjcwMzEyNSBMIDE2LjA0Njg3NSAxMC40NTcwMzEgTCAxNC4yMDMxMjUgMTIuMzA4NTk0IEwgMTEuNDg4MjgxIDkuNTk3NjU2IFogTSAxMC42NTIzNDQgMTAuNDM3NSBMIDEzLjM1OTM3NSAxMy4xNTIzNDQgTCAxNS45MDYyNSAxNS42OTE0MDYgTCAxMy4xOTE0MDYgMTguMzk4NDM4IEwgNy45NTMxMjUgMTMuMTYwMTU2IEwgMy43NzczNDQgMTcuMzM1OTM4IEwgMi43MDcwMzEgMTguMzk4NDM4IEwgMCAxNS42OTE0MDYgTCA3Ljk1MzEyNSA3LjczODI4MSBaIE0gMTAuNjUyMzQ0IDEwLjQzNzUgIi8+PC9zdmc+" alt="Code Climate technical debt" /></a>
 <a href="https://github.com/ifiokjr/remirror/commits/master"><img src="https://img.shields.io/github/commit-activity/m/ifiokjr/remirror.svg?style=for-the-badge&amp;logo=github" alt="GitHub commit activity"></a>&nbsp;&nbsp;<a href="https://github.com/ifiokjr/remirror/commits/master"><img src="https://img.shields.io/github/last-commit/ifiokjr/remirror.svg?style=for-the-badge&amp;logo=github" alt="GitHub last commit" /></a>
 <a href="https://github.com/ifiokjr/remirror/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc"><img src="https://img.shields.io/github/issues-raw/ifiokjr/remirror.svg?style=for-the-badge&amp;logo=github" alt="GitHub issues" /></a>&nbsp;&nbsp;<a href="https://github.com/ifiokjr/remirror/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc"><img src="https://img.shields.io/github/issues-pr/ifiokjr/remirror.svg?style=for-the-badge&amp;logo=github" alt="GitHub pull requests" /></a>
 <a href="https://github.com/ifiokjr/remirror"><img src="https://img.shields.io/github/stars/ifiokjr/remirror.svg?style=for-the-badge&amp;logo=github" alt="GitHub stars" /></a>&nbsp;&nbsp;<a href="https://github.com/ifiokjr/remirror/tags"><img src="https://img.shields.io/github/tag/ifiokjr/remirror.svg?style=for-the-badge&amp;logo=github" alt="GitHub tag (latest SemVer)" /></a>&nbsp;&nbsp;<a href="https://github.com/ifiokjr/remirror/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/remirror.svg?style=for-the-badge" alt="LICENSE" /></a>&nbsp;&nbsp;<a href="https://app.netlify.com/sites/remirror/deploys"><img src="https://api.netlify.com/api/v1/badges/f59cbf02-798f-45dd-a78c-93ec52b08d20/deploy-status" alt="Netlify Status" /></a></p>
@@ -39,11 +39,17 @@
 
 ## Getting Started
 
+⚠️**Warning**: This is still a prerelease library. The docs are poor and the API is subject to change. Over the next few months the quality will be bumped up and the use cases will grow.
+
+For now to learn and understand, the best way is via looking through the `@remirror/ui-*` libraries.
+
 ### Prerequisites
 
-- Typescript `>= 3.3` - Plans to use the latest `as const` syntax
-- React `>= 16.8` - This project relies on hooks
-- Yarn `>= 1.13` - It may work with previous versions as well
+- Typescript `>= 3.4`
+- React `>= 16.8`
+- Yarn `>= 1.13`
+
+[![Epic Mode Heart Example](/support/assets/wysiwyg.png)](https://docs.remirror.org/editors/ui-wysiwyg)
 
 ### Installation
 

support/dependencies/package.json

@@ -24,14 +24,14 @@
     "@types/jest-environment-puppeteer": "4.0.0",
     "@types/jest-image-snapshot": "2.8.0",
     "@types/jest-matcher-utils": "21.0.2",
-    "@types/node": "11.12.2",
+    "@types/node": "11.13.0",
     "@types/prosemirror-test-builder": "1.0.1",
     "@types/puppeteer": "1.12.3",
     "@types/react": "16.8.10",
     "@types/react-dom": "16.8.3",
-    "@types/yargs": "12.0.10",
+    "@types/yargs": "12.0.11",
     "awesome-typescript-loader": "5.2.1",
-    "babel-jest": "24.5.0",
+    "babel-jest": "24.6.0",
     "babel-loader": "8.0.5",
     "babel-plugin-emotion": "10.0.9",
     "babel-plugin-lodash": "3.3.4",
@@ -49,22 +49,22 @@
     "eslint-plugin-import": "2.16.0",
     "eslint-plugin-node": "8.0.1",
     "eslint-plugin-prettier": "3.0.1",
-    "eslint-plugin-promise": "4.0.1",
+    "eslint-plugin-promise": "4.1.1",
     "eslint-plugin-standard": "4.0.0",
     "execa": "1.0.0",
     "husky": "1.3.1",
-    "jest": "24.5.0",
+    "jest": "24.6.0",
     "jest-axe": "3.1.0",
-    "jest-circus": "24.5.0",
-    "jest-cli": "24.5.0",
+    "jest-circus": "24.6.0",
+    "jest-cli": "24.6.0",
     "jest-dom": "3.1.3",
     "jest-emotion": "10.0.10",
     "jest-environment-enzyme": "^7.0.2",
     "jest-enzyme": "^7.0.2",
     "jest-extended": "0.11.1",
     "jest-image-snapshot": "2.8.1",
     "jest-puppeteer": "4.1.0",
-    "jest-watch-typeahead": "0.2.1",
+    "jest-watch-typeahead": "0.3.0",
     "jsdom": "14.0.0",
     "lerna": "3.13.1",
     "lerna-changelog": "0.8.2",
@@ -80,19 +80,19 @@
     "react": "16.8.6",
     "react-addons-test-utils": "15.6.2",
     "react-dom": "16.8.6",
-    "react-testing-library": "6.0.3",
+    "react-testing-library": "6.0.4",
     "rimraf": "2.6.3",
-    "rollup": "1.7.4",
+    "rollup": "1.8.0",
     "rollup-plugin-babel": "4.3.2",
-    "rollup-plugin-commonjs": "9.2.2",
+    "rollup-plugin-commonjs": "9.2.3",
     "rollup-plugin-json": "4.0.0",
     "rollup-plugin-node-builtins": "2.1.2",
     "rollup-plugin-node-globals": "1.4.0",
     "rollup-plugin-node-resolve": "4.0.1",
     "rollup-plugin-replace": "2.1.1",
     "rollup-plugin-terser": "4.0.4",
     "start-server-and-test": "1.7.12",
-    "tslint": "5.14.0",
+    "tslint": "5.15.0",
     "typescript": "3.4.1",
     "typescript-styled-plugin": "0.14.0",
     "typescript-tslint-plugin": "0.3.1"