@builder.io/sdk-qwik 0.14.16 → 0.14.18

package/README.md

@@ -1,169 +1,23 @@
-# Builder.io SDK for Qwik
+# Builder.io Qwik SDK
 
-Use Qwik SDK to connect your Qwik application to Builder.io.
+This is Builder's Qwik SDK.
 
-## Installation
-
-Installing the Qwik SDK is done in two steps:
-
-1. Set up Qwik-city project.
-2. Install the Qwik SDK into your Qwik-city project.
-
-### Fetch
-
-This Package uses fetch. See [these docs](https://github.com/BuilderIO/this-package-uses-fetch/blob/main/README.md) for more information.
-
-### Set up Qwik-city project
-
-1. Follow the instructions on [Qwik-city](https://qwik.builder.io/qwikcity/overview)
-
-```bash
-npm init qwik@latest
-```
-
-Follow instructions for setting up Qwik-city project.
-
-### Install the Qwik SDK into your Qwik-city project
-
-Add `@builder.io/sdk-qwik` to your `package.json` file:
-
-```bash
-npm add --save @builder.io/sdk-qwik
-```
-
-Add Qwik SDK code to a particular route (such as `src/routes/index.tsx`)
-
-```typscript
-import { component$ } from "@builder.io/qwik";
-import { loader$ } from "@builder.io/qwik-city";
-import {
-  getBuilderSearchParams,
-  getContent,
-  RenderContent,
-} from "@builder.io/sdk-qwik";
-
-export const BUILDER_PUBLIC_API_KEY = "YOUR_API_KEY_GOES_HERE"; // ggignore
-export const MODEL = 'page';
-
-export const builderContentLoader = loader$(({ url }) => {
-  return getContent({
-    model: MODEL,
-    apiKey: BUILDER_PUBLIC_API_KEY,
-    options: {
-      ...getBuilderSearchParams(url.searchParams),
-      cachebust: true,
-    },
-    userAttributes: {
-      urlPath: url.pathname || "/",
-    },
-  });
-});
-
-export default component$(() => {
-  const builderContent = builderContentLoader.use();
-  return (
-    <div>
-      <RenderContent
-        model={MODEL}
-        content={builderContent.value}
-        apiKey={BUILDER_PUBLIC_API_KEY}
-        // Optional: pass in a custom component registry
-        // customComponents={CUSTOM_COMPONENTS}
-      />
-    </div>
-  );
-});
-
-// OPTIONAL: need to add custom components to your Qwik app
+## Mitosis
 
-export const MyFunComponent = component$((props: { text: string }) => {
-  const state = useStore({
-    count: 0,
-  });
+This SDK is generated by [Mitosis](https://github.com/BuilderIO/mitosis). To see the Mitosis source-code, go [here](../../).
 
-  return (
-    <div>
-      <h3>{props.text.toUpperCase()}</h3>
-      <p>{state.count}</p>
-      <button onClick$={() => state.count++}>Click me</button>
-    </div>
-  );
-});
+## Feature Support
 
-export const CUSTOM_COMPONENTS: RegisteredComponent[] = [
-  {
-    component: MyFunComponent,
-    name: 'MyFunComponent',
+To check the status of the SDK, look at [these tables](../../README.md#feature-implementation).
 
-    inputs: [
-      {
-        name: 'text',
-        type: 'string',
-        defaultValue: 'Hello world',
-      },
-    ],
-  },
-];
+## Getting Started
 
 ```
-
-### [Beta] Guide to use API Version v3 to query for content
-
-For using API Version `v3`, you need to add `apiVersion: 'v3'` to the `getContent` function and in the `RenderContent` tag. For example:
-
-```typscript
-import { component$ } from "@builder.io/qwik";
-import { loader$ } from "@builder.io/qwik-city";
-import {
-  getBuilderSearchParams,
-  getContent,
-  RenderContent,
-} from "@builder.io/sdk-qwik";
-
-export const BUILDER_PUBLIC_API_KEY = "YOUR_API_KEY_GOES_HERE";
-export const MODEL = "page";
-
-export const builderContentLoader = loader$(({ url }) => {
-  return getContent({
-    model: MODEL,
-    apiKey: BUILDER_PUBLIC_API_KEY,
-    apiVersion: "v3",
-    options: {
-      ...getBuilderSearchParams(url.searchParams),
-      cachebust: true,
-    },
-    userAttributes: {
-      urlPath: url.pathname || "/",
-    },
-  });
-});
-
-export default component$(() => {
-  const builderContent = builderContentLoader.use();
-  return (
-    <div>
-      <RenderContent
-        model={MODEL}
-        content={builderContent.value}
-        apiKey={BUILDER_PUBLIC_API_KEY}
-        apiVersion="v3"
-      />
-    </div>
-  );
-});
-
+npm install @builder.io/sdk-svelte@dev
 ```
 
-#### Reasons to switch to API Version v3
-
-- Better, more scalable infra: Query v3 is built on global scale infrastructure to ensure fast response times and high availability
-- Ability to ship more features, faster: Query V3 will allow us to keep shipping the latest features to our customers without breaking fundamental flows. These will be shipped only to Query V3 and not to the older versions of the query API
+Take a look at [our example repo](https://github.com/BuilderIO/builder/tree/main/examples/qwik) for how to use this SDK.
 
-_Coming soon..._
+## Fetch
 
-- Better support for localization: Some of the newer features of localization and querying based on it will be better supported in Query V3
-- Support multi-level nested references: Query V3 will allow you to query, resolve, and return content that has nested references of other contents and symbols.
-
-## Mitosis
-
-This SDK is generated by [Mitosis](https://github.com/BuilderIO/mitosis). To see the Mitosis source-code, go [here](https://github.com/BuilderIO/builder/tree/main/packages/sdks/src).
+This Package uses fetch. See [these docs](https://github.com/BuilderIO/this-package-uses-fetch/blob/main/README.md) for more information.