solid-devtools - npm Package Compare versions

Comparing version 0.10.0 to 0.10.1

package.json

 {
   "name": "solid-devtools",
-  "version": "0.10.0",
+  "version": "0.10.1",
   "description": "Runtime helpers for hooking up SolidJS application with Solid Devtools",
@@ -70,6 +70,6 @@ "license": "MIT",
   "dependencies": {
-    "@solid-devtools/debugger": "^0.4.0",
+    "@solid-devtools/debugger": "^0.4.1",
     "@solid-devtools/extension-adapter": "^0.10.0",
-    "@solid-devtools/locator": "^0.10.0",
-    "@solid-devtools/transform": "^0.5.0"
+    "@solid-devtools/locator": "^0.10.1",
+    "@solid-devtools/transform": "^0.6.0"
   },
@@ -76,0 +76,0 @@ "peerDependencies": {

README.md

@@ -11,4 +11,4 @@ <a href="https://github.com/thetarnav/solid-devtools/tree/main/packages/main#readme" target="_blank">
 
-- [Debugger](https://github.com/thetarnav/solid-devtools/tree/main/packages/debugger#readme)
-- [Extension Adapter](https://github.com/thetarnav/solid-devtools/tree/main/packages/extension-adapter#readme) _(this one is automatically enabled)_
+- [Debugger](https://github.com/thetarnav/solid-devtools/tree/main/packages/debugger#readme) _(automatically enabled)_
+- [Extension Adapter](https://github.com/thetarnav/solid-devtools/tree/main/packages/extension-adapter#readme) _(automatically enabled)_
 - [Locator](https://github.com/thetarnav/solid-devtools/tree/main/packages/locator#readme) — [How to use it](#using-the-locator-package)
@@ -29,5 +29,16 @@ - [Babel Plugin](https://github.com/thetarnav/solid-devtools/tree/main/packages/transform#readme) — [How to use it](#enabling-the-babel-plugin)
 
+### Import the script
+
+All you need to do is import the devtools script in your app entry file, and the debugger will automatically find roots in your app and track them.
+
+```ts
+import "solid-devtools"
+// and that's it!
+```
+
+Importing `"solid-devtools"` package is attaching the [debugger](https://github.com/thetarnav/solid-devtools/tree/main/packages/debugger#readme) to your application and runs [extension-adapter](https://github.com/thetarnav/solid-devtools/tree/main/packages/extension-adapter#readme). In other words, it is creating a platform for other devtools to use. It doesn't provide any functionality by itself.
+
 ### Using the locator package
 
-The `solid-devtools` package comes with the [Locator](https://github.com/thetarnav/solid-devtools/tree/main/packages/locator#readme) package included.
+The `solid-devtools` package comes with the [Locator](https://github.com/thetarnav/solid-devtools/tree/main/packages/locator#readme) package included. It's not neccessary to use it! But you can.
 
@@ -40,5 +51,4 @@ [**Follow this guide of the locator package**](https://github.com/thetarnav/solid-devtools/tree/main/packages/locator#Getting-Started)
 
-```**Note**
-In some cases import from `solid-devtools/vite` causes errors in loading vite config. I haven't figured out the cause yet. But to avoid the error, you can import from `@solid-devtools/transform` instead.
-```
+> **Note**
+> In some cases import from `solid-devtools/vite` causes errors in loading vite config. I haven't figured out the cause yet. But to avoid the error, you can import from `@solid-devtools/transform` instead.
 
@@ -45,0 +55,0 @@ To enable it you need to add it to plugins array in your `.vite.config.js` file:

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12695

increased by5.68%

Number of lines in readme file

72

increased by16.13%

Dependency changes

• - Removed@solid-devtools/transform@0.5.0(transitive)

• Updated@solid-devtools/debugger@^0.4.1

• Updated@solid-devtools/locator@^0.10.1

• Updated@solid-devtools/transform@^0.6.0