diff --git a/.changeset/chilly-lamps-float.md b/.changeset/chilly-lamps-float.md new file mode 100644 index 00000000..f56bb401 --- /dev/null +++ b/.changeset/chilly-lamps-float.md @@ -0,0 +1,5 @@ +--- +"@burnt-labs/abstraxion": patch +--- + +Restore readme to the abstraxtion library diff --git a/packages/abstraxion/README.md b/packages/abstraxion/README.md new file mode 100644 index 00000000..01c5d610 --- /dev/null +++ b/packages/abstraxion/README.md @@ -0,0 +1,69 @@ +# abstraxion + +The `abstraxion` library is an account abstraction solution tailored for the XION chain. It offers a clean and streamlined way to create abstract accounts, sign transactions, integrating seamlessly with [graz](https://github.com/graz-sh/graz), to additionally provide traditional cosmos wallet functionalities. + +## Installation + +Run the following: + +``` +npm i @burnt-labs/abstraxion +``` + +## Basic Usage + +Find an implementation demo here: [abstraxion demo](../../apps/demo-app) + +First, wrap your app in the `AbstraxionProvider` at the top level + +``` +"use client"; +import { AbstraxionProvider } from "abstraxion"; +import "./globals.css"; +import "@burnt-labs/ui/styles.css"; +import "@burnt-labs/abstraxion/styles.css"; + +export default function RootLayout({ + children, +}: { + children: React.ReactNode; +}) { + return ( + +
+