From 1dae1e00d1130ef970286c4b0e7212b4f169bb95 Mon Sep 17 00:00:00 2001 From: Cheng Wang Date: Tue, 15 Oct 2024 17:44:47 +0200 Subject: [PATCH] Update readme --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 81ebb88..f9ca8f8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,6 @@ -This is a Alephium template project for the -[Next.js](https://nextjs.org/) framework, it is bootstrapped with the -following command: +# Alephium Next.js Template -``` -npx @alephium/cli init $project-name --template nextjs -``` +This is a Alephium template project for the [Next.js](https://nextjs.org/) framework. This template project demonstrates how to implement a simple token faucet and expose it with a Web UI using Next.js. @@ -20,14 +16,14 @@ npm install ### Start a local devnet for testing and development ``` -npx @alephium/cli@latest devnet start +cd docker && docker compose up ``` ### Deploy the token faucet contract ```bash # In this case devnet -npx @alephium/cli deploy -n devnet +npm run devnet:deploy ``` This will compile and deploy the token faucet contracts to all of the @@ -38,10 +34,10 @@ contracts first: ```bash # Compile -npx @alephium/cli compile +npm run compile # Test -npx @alephium/cli test +npm run test ``` ### Run the development server @@ -63,8 +59,8 @@ to interact with the application. To learn more about smart contract development on Alephium, take a look at the following resources: -- [Alephium Web3 SDK Guide](https://docs.alephium.org/dapps/alephium-web3/) - Learn about Alephium Web3 SDK -- [Ralph Language](https://docs.alephium.org/ralph/getting-started) - A guide to the Ralph programming language +- [Alephium Web3 SDK Guide](https://docs.alephium.org/sdk/getting-started/) - Learn about Alephium Web3 SDK +- [Ralph Language](https://docs.alephium.org/ralph/) - A guide to the Ralph programming language You can check out the [Alephium GitHub repositories](https://github.com/alephium) for more information - your