Merge pull request #35 from fortanix/mkrause/241120-update-readme

Update README

README.md

@@ -11,9 +11,13 @@ You can find the latest Storybook documentation [here](https://fortanix.github.i
 
 ## Usage
 
+Requirements:
+
+- React v19 or higher.
+
 Installation:
 
-```sh
+```console
 npm install --save @fortanix/baklava
 ```
 
@@ -30,13 +34,13 @@ this will be supported out of the box. Otherwise, you may need to configure your
 Icons are loaded through SVG sprites. This requires some additional setup. If you're using vite, install the
 `vite-plugin-svg-icons` plugin:
 
-```sh
+```console
 npm install --save vite-plugin-svg-icons
 ```
 
 Then, add the following to the `plugins` array in your vite config:
 
-```
+```typescript
 createSvgIconsPlugin({
   iconDirs: [path.resolve(__dirname, 'node_modules/@fortanix/baklava/src/assets/icons')],
   symbolId: 'baklava-icon-[name]',
@@ -45,6 +49,12 @@ createSvgIconsPlugin({
 }),
 ```
 
+Additionally, you will need to add the following import in your main entry file:
+
+```typescript
+import 'virtual:svg-icons-register';
+```
+
 
 ## Contributing
 

package.json

@@ -107,5 +107,9 @@
   "overrides": {
     "@types/react": "npm:types-react@rc",
     "@types/react-dom": "npm:types-react-dom@rc"
+  },
+  "peerDependencies": {
+    "react": ">= 19.0.0-rc.1",
+    "react-dom": ">= 19.0.0-rc.1"
   }
-}
+}

package.json.js

@@ -166,7 +166,11 @@ const packageConfig = {
     // See https://react.dev/blog/2024/04/25/react-19-upgrade-guide#installing
     '@types/react': 'npm:types-react@rc',
     '@types/react-dom': 'npm:types-react-dom@rc',
-  }
+  },
+  peerDependencies: {
+    'react': '>= 19.0.0-rc.1',
+    'react-dom': '>= 19.0.0-rc.1',
+  },
 };
 
 const packageConfigWithComment = {
@@ -180,4 +184,4 @@ const packageConfigWithComment = {
 const packageConfigFormatted = JSON.stringify(packageConfigWithComment, null, 2);
 
 // Write to `package.json`
-fs.writeFileSync('./package.json', packageConfigFormatted);
+fs.writeFileSync('./package.json', packageConfigFormatted + '\n');