diff --git a/.changeset/polite-sloths-behave.md b/.changeset/polite-sloths-behave.md new file mode 100644 index 0000000..195b026 --- /dev/null +++ b/.changeset/polite-sloths-behave.md @@ -0,0 +1,6 @@ +--- +"vite-plugin-react-router-amplify-hosting": patch +"amplify-adapter-react-router": patch +--- + +docs: update README.md diff --git a/README.md b/README.md index c0b5087..77ba3bc 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,4 @@ This project provide following packages: - `vite-plugin-react-router-amplify-hosting` is Vite plugin for React Router SSR on Amplify Hosting. See [more information](./packages/vite-plugin-react-router-amplify-hosting/README.md). +- `amplify-adapter-react-router` contains the AWS Amplify React Router Adapter. For more information on using React Router in your application please reference [more information](./packages/amplify-adapter-react-router/README.md). diff --git a/packages/amplify-adapter-react-router/README.md b/packages/amplify-adapter-react-router/README.md index 6e0c92c..f979337 100644 --- a/packages/amplify-adapter-react-router/README.md +++ b/packages/amplify-adapter-react-router/README.md @@ -1,6 +1,6 @@ # AWS Amplify React Router Adapter -This package is the AWS Amplify React Router Adapter. +This package contains the AWS Amplify React Router Adapter. ## Install diff --git a/packages/vite-plugin-react-router-amplify-hosting/README.md b/packages/vite-plugin-react-router-amplify-hosting/README.md index ffe06cb..3caeb78 100644 --- a/packages/vite-plugin-react-router-amplify-hosting/README.md +++ b/packages/vite-plugin-react-router-amplify-hosting/README.md @@ -4,7 +4,7 @@ This package is vite plugin for React Router SSR on Amplify Hosting. ## Features -- Generate `deply-manifest.json`. +- Generate `deploy-manifest.json`. - Generate and bundle a `server.mjs` as compute entrypoint file. - Build the folder structure that Amplify expects for the deployment bundle.