Skip to content

Commit e8c33d8

Browse files
authored
Readme update (#186)
1 parent 4db867d commit e8c33d8

File tree

2 files changed

+26
-38
lines changed

2 files changed

+26
-38
lines changed

.changeset/sharp-eels-bow.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"create-eth": patch
3+
---
4+
5+
update readme

README.md

Lines changed: 21 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
1-
> ⚠️ Under active development.
2-
>
3-
> If you find any bug, please report as [issue](https://github.com/scaffold-eth/create-eth/issues) or send a message in [🏗 scaffold-eth developers chat](https://t.me/joinchat/F7nCRK3kI93PoCOk)
4-
51
# 🏗 create-eth
62

73
CLI to create decentralized applications (dapps) using Scaffold-ETH 2.
84

9-
This is an alternative method of installing Scaffold-ETH. Instead of directly [cloning SE-2](https://docs.scaffoldeth.io/quick-start/installation#option-1-setup-using-git-clone), you can use create-eth to create your own custom instance, where you can choose among several configurations and extensions.
10-
115
<h4 align="center">
12-
<a href="https://github.com/scaffold-eth/scaffold-eth-2">SE-2 Repo</a> |
13-
<a href="https://docs.scaffoldeth.io">SE-2 Docs</a> |
6+
<a href="https://docs.scaffoldeth.io">SE-2 Documentation</a> |
147
<a href="https://scaffoldeth.io">SE-2 Website</a>
158
</h4>
169

@@ -26,40 +19,32 @@ Before you begin, you need to install the following tools:
2619

2720
To get started with Scaffold-ETH 2, follow the steps below:
2821

29-
1. Install from NPM Registry and follow the CLI instructions.
22+
1. Install the latest version of Scaffold-ETH 2
3023

3124
```
3225
npx create-eth@latest
3326
```
3427

35-
> 💬 Hint: If you choose Foundry as solidity framework in the CLI, you'll also need Foundryup installed in your machine. Checkout: [getfoundry.sh](https://getfoundry.sh)
28+
This command will install all the necessary packages and dependencies, so it might take a while.
29+
30+
> [!NOTE]
31+
> You can also initialize your project with one of our extensions to add specific features or starter-kits. Learn more in our [extensions documentation](https://docs.scaffoldeth.io/extensions/).
3632
3733
2. Run a local network in the first terminal:
3834

3935
```
4036
yarn chain
4137
```
4238

43-
This command starts a local Ethereum network using Hardhat or Foundry, depending on which one you selected in the CLI. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in:
44-
45-
- `packages/hardhat/hardhat.config.ts` if you have Hardhat as solidity framework.
46-
- `packages/foundry/foundry.toml` if you have Foundry as solidity framework.
39+
This command starts a local Ethereum network that runs on your local machine and can be used for testing and development. Learn how to [customize your network configuration](https://docs.scaffoldeth.io/quick-start/environment#1-initialize-a-local-blockchain).
4740

4841
3. On a second terminal, deploy the test contract:
4942

5043
```
5144
yarn deploy
5245
```
5346

54-
This command deploys a test smart contract to the local network. The contract can be modified to suit your needs. Is located in:
55-
56-
- Hardhat => `packages/hardhat/contracts`
57-
- Foundry => `packages/foundry/contracts`
58-
59-
The `yarn deploy` command uses a deploy script to deploy the contract to the network. You can customize it. Is located in:
60-
61-
- Hardhat => `packages/hardhat/deploy`
62-
- Foundry => `packages/foundry/script`
47+
This command deploys a test smart contract to the local network. You can find more information about how to customize your contract and deployment script in our [documentation](https://docs.scaffoldeth.io/quick-start/environment#2-deploy-your-smart-contract).
6348

6449
4. On a third terminal, start your NextJS app:
6550

@@ -69,30 +54,28 @@ yarn start
6954

7055
Visit your app on: `http://localhost:3000`. You can interact with your smart contract using the `Debug Contracts` page. You can tweak the app config in `packages/nextjs/scaffold.config.ts`.
7156

72-
Run smart contract test with `yarn hardhat:test` or `yarn foundry:test` depending of your solidity framework.
73-
7457
**What's next**:
7558

76-
Visit the [What's next section of our docs](https://docs.scaffoldeth.io/quick-start/environment#whats-next) to learn how to:
77-
78-
- Edit your smart contracts
79-
- Edit your deployment scripts
80-
- Customize your frontend
81-
- Edit the app config
82-
- Writing and running tests
83-
- [Setting up external services and API keys](https://docs.scaffoldeth.io/deploying/deploy-smart-contracts#configuration-of-third-party-services-for-production-grade-apps)
59+
Visit the [What's next section of our docs](https://docs.scaffoldeth.io/quick-start/environment#whats-next) to learn how to customize your contracts, frontend, and more.
8460

8561
## Documentation
8662

8763
Visit our [docs](https://docs.scaffoldeth.io) to learn all the technical details and guides of Scaffold-ETH 2.
8864

8965
To know more about its features, check out our [website](https://scaffoldeth.io).
9066

91-
## Contributing to create-eth
67+
Watch [BG Labs](https://youtube.com/playlist?list=PLJz1HruEnenD77QAsqnk7KG8rSOMk0B99&si=JXZRn78_NBcvJJoZ) - our video series on building with Scaffold-ETH 2.
68+
69+
## Contributing
9270

93-
We welcome contributions to create-eth and Scaffold-ETH 2!
71+
Built by [BuidlGuidl](https://buidlguidl.com) builders, we welcome contributions to create-eth!
9472

95-
For more information and guidelines for contributing, please see:
73+
For more information and guidelines for contributing, please see [CONTRIBUTING.MD](https://github.com/scaffold-eth/create-eth/blob/main/CONTRIBUTING.md)
9674

97-
- [create-eth CONTRIBUTING.MD](https://github.com/scaffold-eth/create-eth/blob/main/CONTRIBUTING.md) if you want to contribute to the CLI.
98-
- [Scaffold-ETH 2 CONTRIBUTING.MD](https://github.com/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) if you want to contribute to SE-2 base code.
75+
## Community
76+
77+
<h4 align="center">
78+
<a href="https://x.com/buidlguidl">Buidlguidl X</a> |
79+
<a href="https://x.com/ScaffoldETH">SE-2 X</a> |
80+
<a href="https://t.me/joinchat/F7nCRK3kI93PoCOk">SE-2 developers chat</a>
81+
</h4>

0 commit comments

Comments
 (0)