feat(solidjs): Update README with routing instrumentation instructions

Author: andreiborza

packages/solidjs/README.md

@@ -7,3 +7,44 @@
 # Official Sentry SDK for SolidJS
 
 This SDK is work in progress, and should not be used before officially released.
+
+# Solid Router
+
+The Solid Router instrumentation uses the Solid Router library to create navigation spans to ensure you collect
+meaningful performance data about the health of your page loads and associated requests.
+
+Add `Sentry.solidRouterBrowserTracingIntegration` instead of the regular `Sentry.browserTracingIntegration` and provide
+the hooks it needs to enable performance tracing:
+
+`useBeforeLeave` from `@solidjs/router`  
+`useLocation` from `@solidjs/router`
+
+Make sure `Sentry.solidRouterBrowserTracingIntegration` is initialized by your `Sentry.init` call, before you wrap
+`Router`. Otherwise, the routing instrumentation may not work properly.
+
+Wrap `Router`, `MemoryRouter` or `HashRouter` from `@solidjs/router` using `Sentry.withSentryRouterRouting`. This
+creates a higher order component, which will enable Sentry to reach your router context.
+
+```js
+import * as Sentry from '@sentry/solidjs';
+import { Route, Router, useBeforeLeave, useLocation } from '@solidjs/router';
+
+Sentry.init({
+  dsn: '__PUBLIC_DSN__',
+  integrations: [Sentry.solidRouterBrowserTracingIntegration({ useBeforeLeave, useLocation })],
+  tracesSampleRate: 1.0, //  Capture 100% of the transactions
+  debug: true,
+});
+
+const SentryRouter = Sentry.withSentryRouterRouting(Router);
+
+render(
+  () => (
+    <SentryRouter>
+      <Route path="/" component={App} />
+      ...
+    </SentryRouter>
+  ),
+  document.getElementById('root'),
+);
+```