@ab-org/sdk-core 0.1.0 → 0.1.2-beta.0

package/README.md

@@ -3,5 +3,34 @@
 Base wallet abstractions: session store, wallet connectors, provider registry (plugin & social), and lightweight controllers.
 
 ```ts
+import { WalletConnector, MetaMaskProvider } from "@ab-org/sdk-core";
+import { CubistSocialProvider } from "@ab-org/sdk-core/social";
+```
+
+- `@ab-org/sdk-core` keeps the legacy root import compatible.
+- `@ab-org/sdk-core/social` contains CubeSigner and social-wallet runtime helpers.
+- `@ab-org/sdk-core/social/auth` narrows to CubeSigner auth + EVM wallet-provider helpers.
+- `@ab-org/sdk-core/social/provider` narrows to the social provider abstraction.
+- The social auth runtime is bundled internally and should not require custom `next.config.js` or `vite.config.ts` workarounds.
+
+## Migration
+
+If you previously imported social runtime directly from the root entry, that import still works. For new code, prefer the social subpath:
+
+```ts
+// before
 import { WalletConnector, MetaMaskProvider, CubistSocialProvider } from "@ab-org/sdk-core";
+
+// after
+import { WalletConnector, MetaMaskProvider } from "@ab-org/sdk-core";
+import { CubistSocialProvider } from "@ab-org/sdk-core/social";
+```
+
+The same applies to CubeSigner runtime helpers such as `CubeSignerAuth` and `createCubistEvmWalletProvider`.
+
+When you want a narrower subpath:
+
+```ts
+import { CubeSignerAuth, createCubistEvmWalletProvider } from "@ab-org/sdk-core/social/auth";
+import { CubistSocialProvider } from "@ab-org/sdk-core/social/provider";
 ```