@machinemetrics/mm-react-tools 2.2.0-dev → 3.0.0

package/README.md

@@ -14,7 +14,7 @@ Components, hooks, and helper functions for writing React apps using MachineMetr
 ## Install
 
 ```bash
-yarn add mm-react-tools
+npm install @machinemetrics/mm-react-tools
 ```
 
 ## Peer Dependencies
@@ -22,7 +22,7 @@ yarn add mm-react-tools
 Due to how Apollo, React, and other libraries work, there are some additional dependencies that you'll need to include in your project:
 
 ```bash
-yarn add react react-router-dom styled-components @apollo/client subscriptions-transport-ws graphql
+npm install react react-router-dom styled-components @apollo/client
 ```
 
 ## Getting Started
@@ -32,12 +32,11 @@ Wrap your application in the `MMProvider` to wire up everything necessary to aut
 ```jsx
 import React from 'react';
 import ReactDOM from 'react-dom';
-import { MMProvider } from 'mm-react-tools';
+import { MMProvider } from '@machinemetrics/mm-react-tools';
 import App from './App';
 
 ReactDOM.render(
   <MMProvider
-    domain={process.env.REACT_APP_URL}
     clientId={process.env.REACT_APP_CLIENT_ID}
     clientSecret={process.env.REACT_APP_CLIENT_SECRET}
     releaseStage={process.env.REACT_APP_RELEASE_STAGE}
@@ -56,17 +55,19 @@ Use the `ProtectedRoute` to kick off the login flow.
 ```jsx
 // App.js
 import React from 'react';
-import { Route } from 'react-router-dom';
-import { PrivateLayout } from 'mm-react-tools';
+import { Route, Routes } from 'react-router-dom';
+import { PrivateLayout } from '@machinemetrics/mm-react-tools';
 import PublicPage from './PublicPage';
 import PrivatePage from './PrivatePage';
 
 function App() {
   return (
-    <Route exact path='/public' element={<PublicPage />} />
-    <Route element={<PrivateLayout />}>
-      <Route path="/private" element={<PrivatePage />}>
-    </Route>
+    <Routes>
+      <Route exact path='/public' element={<PublicPage />} />
+      <Route element={<PrivateLayout />}>
+        <Route path="/private" element={<PrivatePage />}>
+      </Route>
+    <Routes>
   );
 }