\n\n \n\n \n\n## Installation\n\nRemount is available through the npm package repository. React 18 is required.\n\n```sh\n# npm\nnpm install remount react react-dom\n# yarn\nyarn add remount react react-dom\n```\n\n- Via yarn: `yarn add remount`\n- or npm: `npm install remount`\n\n## Usage\n\nLet's start with any React component. Here's one:\n\n```js\nconst Greeter = ({ name }) => {\n return
Hello, {name}!
\n}\n```\n\nUse _define()_ to define custom elements. Let's define a `` element:\n\n```js\nimport { define } from 'remount'\n\ndefine({ 'x-greeter': Greeter })\n```\n\nYou can now use it anywhere in your HTML! :boom:\n\n```html\n\n```\n\n⚡ **[API documentation →](docs/api.md)**\n\n## Use cases\n\nSome ideas on why you might want to consider Remount for your project:\n\n| | |\n| ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n|
| ✨ **Adding React to non-SPA apps** You can use React components on any page of a \"regular\" HTML site. Great for adding React to apps built on Rails or Phoenix. |\n| | |\n|
\n \n
\n
