Skip to content

Commit f5563c4

Browse files
authored
Update README.md
1 parent aff0ea3 commit f5563c4

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Typesafe react hooks to interact with [ink!](https://use.ink/) smart contracts p
1919
### Features
2020
- Fully typesafe react hooks at contract messages & events level
2121
- Choose your favorite wallet connector (Built-in Typink Connector, [SubConnect](https://github.com/Koniverse/SubConnect-v2), [Talisman Connect](https://github.com/TalismanSociety/talisman-connect), or build your own connector ...)
22+
- Start a new project from scratch easily with `create-typink` cli.
2223
- Support multiple networks, lazily initialize when in-use.
2324
- ... and more to come
2425

@@ -37,18 +38,21 @@ pnpm add typink dedot
3738

3839
Typink heavily uses Typescript to enable & ensure type-safety, so we recommend using Typescript for your Dapp project. Typink will also work with plain Javascript, but you don't get the auto-completion & suggestions when interacting with your ink! contracts.
3940

40-
### Configure your project
41+
### Starting a new project from scratch
4142

42-
> [!NOTE]
43-
>
44-
> **Starting a new project from scratch?**
45-
>
46-
> Try out the prerelease of typink dapp template: https://github.com/dedotdev/typink-dapp-template.
47-
>
48-
> Clone the repo & have fun!
43+
Typink comes with a cli to help you start a new project from scratch faster & easier, to create a new project, run the below command:
44+
45+
```ssh
46+
npx create-typink@latest
47+
```
48+
49+
50+
<img width="1919" alt="new-typink-project" src="https://github.com/user-attachments/assets/b10b1366-f97b-41a7-b3e9-97ceb1bd0748" />
4951

5052

5153

54+
55+
### Configure your project
5256
#### 1. Deploy your contracts and setup contract deployments
5357

5458
Typink needs to know your contract deployments information (address, metadata, ...) to help you do the magic under the hood.

0 commit comments

Comments
 (0)