fix: update documentation for ref (#37)

roerohan · Jul 30, 2022 · 3bbe643 · 3bbe643
1 parent aa25dcb
commit 3bbe643
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 97 deletions.
diff --git a/README.md b/README.md
@@ -108,10 +108,12 @@ npm run build:lib
 A `VncScreen` component is exposed from the library, to which you can pass the required and optional props. For example,
 
 ```ts
-import React from 'react';
+import React, { useRef } from 'react';
 import { VncScreen } from 'react-vnc';
 
 function App() {
+  const ref = useRef();
+
   return (
     <VncScreen
       url='ws://your-vnc-url.com'
@@ -214,4 +216,4 @@ Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more informati
 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
 [roerohan-url]: https://roerohan.github.io
 [issues-shield]: https://img.shields.io/github/issues/roerohan/react-vnc.svg?style=flat-square
-[issues-url]: https://github.com/roerohan/react-vnc/issues
+[issues-url]: https://github.com/roerohan/react-vnc/issues
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -92,7 +92,7 @@
     "husky": "^7.0.0",
     "is-ci": "^2.0.0",
     "rollup": "^2.44.0",
-    "rollup-plugin-typescript2": "^0.30.0",
+    "rollup-plugin-typescript2": "^0.32.1",
     "semantic-release": "^18.0.0",
     "typescript": "^4.5.5"
   },