chore(docs): improve docs and logo (#73)

sentioxyz · Jan 31, 2024 · a7ec35f · a7ec35f
1 parent 5516c11
commit a7ec35f
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 6 deletions.
diff --git a/Readme.md b/Readme.md
@@ -1,4 +1,8 @@
-# Typemove 
+<p align="center">
+  <img src="./images/logo.png" width="300" alt="TypeChain">
+</p>
+
+# TypeMove 
 Generate TypeScript bindings for Move smart contracts. (currently support Aptos & SUI).
 Developed by [Sentio](sentio.xyz).
 ## Features

diff --git a/images/logo.png b/images/logo.png
diff --git a/packages/aptos/Readme.md b/packages/aptos/Readme.md
@@ -1,4 +1,8 @@
-# Typemove 
+<p align="center">
+  <img src="../../images/logo.png" width="300" alt="TypeChain">
+</p>
+
+# TypeMove 
 Generate TypeScript bindings for Aptos contracts.
 ## Features
  - Code generation for Aptos smart contract based on ABI

diff --git a/packages/sui/Readme.md b/packages/sui/Readme.md
@@ -1,4 +1,8 @@
-# Typemove 
+<p align="center">
+  <img src="../../images/logo.png" width="300" alt="TypeChain">
+</p>
+
+# TypeMove 
 Generate TypeScript bindings for Sui contracts.
 ## Features
  - Code generation for SUI smart contract based on ABI
@@ -43,7 +47,7 @@ A few examples:
 
 ### Decode Object
 ```typescript
-import { defaultMoveCoder } from '../move-coder.js'
+import { defaultMoveCoder } from '@typemove/sui'
 import { single_collateral } from './types/testnet/0xebaa2ad3eacc230f309cd933958cc52684df0a41ae7ac214d186b80f830867d2.js'
 
 const res = await defaultMoveCoder().decodedType(
@@ -52,8 +56,8 @@ const res = await defaultMoveCoder().decodedType(
 )
 ```
 
-<details>
-  <summary>Without TypeMove</summary>
+<details open>
+  <summary>Click to see what's like without TypeMove</summary>
 
 ```typescript
 export interface Info {