@neo4j-cypher/react-codemirror 1.0.2 → 2.0.0-alpha.0

package/README.md

@@ -1,32 +1,11 @@
-### @neo4j-cypher/react-codemirror
+# React Codemirror
 
-This package exports a React component that provides a cypher editor using codemirror 6.
+This package can be built with `npm run build` and then published to npm with `npm publish`.
 
-You can use this package like the following:
+### Completion Icons
 
-```
-import React from 'react';
-import CypherEditor from '@neo4j-cypher/react-codemirror';
+We use unmodified copies of Visual Studio Code Icons from microsofts repository [here](https://github.com/microsoft/vscode-icons) licensed under creative commons.
 
-const editorProps = {
-  onValueChanged: value => {}, // optional
-  onFocusChanged: focused => {}, // optional
-  onScrollChanged: scrollInfo => {}, // optional
-  onPositionChanged: ({ line, column, position }) => {}, // optional
-  initialOptions: {
-    theme: 'light', // optional, defaults to light
-    extensions: [ /* override extensions  */ ] // optional, defaults to a sensible list of extensions.
-  },
-  initialSchema: { /* ... */ }, // optional, see example in demos
-  initialValue: 'this is the text to show in the editor',
-  initialPosition: { row: 2, column: 3},  // optional, rows are 1 based, columns are 0 based
-  classNames: [], // optional, array of classnames to add to the root dom element.
-  theme: 'light' // optional, should be light or dark, defaults to light
-};
+### Build notes
 
-const MyReactComponent = () => {
-  return (
-    <CypherEditor {...editorProps} />
-  );
-}
-```
+We need to bundle the other project dependencies into the build until we've published those packages. When we do publish them, we can just do the same "tsc" build step as for example `language-support`.