@cetusprotocol/terminal 0.1.0 → 0.1.2

package/README.md

@@ -1,35 +1,39 @@
-# Sui dApp Starter Template
+# Cetus Terminal
 
-This dApp was created using `@mysten/create-dapp` that sets up a basic React
-Client dApp using the following tools:
+Visit our Demo / Playground over at [https://terminal.cetus.zone](https://terminal.cetus.zone)
 
-- [React](https://react.dev/) as the UI framework
-- [TypeScript](https://www.typescriptlang.org/) for type checking
-- [Vite](https://vitejs.dev/) for build tooling
-- [Radix UI](https://www.radix-ui.com/) for pre-built UI components
-- [ESLint](https://eslint.org/)
-- [`@mysten/dapp-kit`](https://sdk.mystenlabs.com/dapp-kit) for connecting to
-  wallets and loading data
-- [pnpm](https://pnpm.io/) for package management
+## Install from NPM and use it in your react project
 
-## Starting your dApp
-
-To install dependencies you can run
+To install 
 
 ```bash
-pnpm install
+npm install @cetusprotocol/terminal
 ```
 
-To start your dApp in development mode run
 
-```bash
-pnpm dev
-```
 
-## Building
+To use the components in the @cetusprotocol/terminal, wrap your app with the providers shown in the following example. The props available on the providers are covered in more detail in their respective pages.
 
-To build your app for deployment you can run
+```jsx
+import { createNetworkConfig, SuiClientProvider, WalletProvider } from'@mysten/dapp-kit';
+import { getFullnodeUrl } from'@mysten/sui/client';
+import { QueryClient, QueryClientProvider } from'@tanstack/react-query';
 
-```bash
-pnpm build
+// Config options for the networks you want to connect to
+const { networkConfig } =createNetworkConfig({
+  mainnet: { url:getFullnodeUrl('mainnet') },
+});
+constqueryClient=newQueryClient();
+
+functionApp() {
+  return (
+    <QueryClientProviderclient={queryClient}>
+		<SuiClientProvidernetworks={networkConfig} defaultNetwork="localnet">
+			<WalletProvider>
+			     <YourApp />
+			</WalletProvider>
+		 </SuiClientProvider>
+    </QueryClientProvider>
+  );
+}
 ```