Readme update

[rin-st]

Second part from #99 :

Also probably we can remove the yarn chain, yarn deploy stuff and point it them to SE-2 docs for that

• removed requirements and quickstart blocks
• renamed documentation block to getting started and added link to QuickStart Guide so it replaced both requirements and quickstart blocks

Also:

• removed outdated git clone info from main description
• some smaller adjustments

First part from #99:

I think maybe we should have section which points people to creating third party extensions.

I'm not sure about this part (55% not to add it/ 45% to add), because third-party extensions part looks too specific for such a short readme. But I'm very open to change it

Fixes #99

[technophile-04]

Tysm Rinat 🙌

Since this will be shown on npm readme. I think its important to highlight npx create-eth@latest command and also probably three magic commands make sense? Probably remove SE-2 repo reference from contributing stuff as well? Also remove under development line?

Maybe we have it like this?

---

---

🏗 create-eth

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

SE-2 Documentation | SE-2 Website

Requirements

Before you begin, you need to install the following tools:

• Node (>= v18.18)
• Yarn (v1 or v2+)
• Git

Quickstart

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

1. Install the latest version of Scaffold-ETH 2

npx create-eth@latest

This command will install all the necessary packages and dependencies, so it might take a while.

Note

You can also initialize your project with one of our extensions to add specific features or starter-kits. Learn more in our extensions documentation.

2. Run a local network in the first terminal:

yarn chain

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.

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

yarn deploy

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.

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

yarn start

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.

Documentation

Visit our docs to learn all the technical details and guides of Scaffold-ETH 2.

To know more about its features, check out our website.

Contributing

---

---

I'm not sure about this part (55% not to add it/ 45% to add), because third-party extensions part looks too specific for such a short readme. But I'm very open to change it

Ohh yes yes let's not add that part

[rin-st]

From the issue I thought we don't need requirements and yarn chain/deploy etc but this

Since this will be shown on npm readme.

makes sense

Updated Readme as you suggested

Thanks Shiv!

[Pabl0cks]

Nice job @rin-st and @technophile-04 !! Only added a nitpick.

Even I really love how simple the readme looks like now, I have a couple of questions to discuss:

• Do you think we should add some kind of next steps (maybe could be simplified to a 1 liner to the website section) like we have in SE-2 Readme above documentation section
• Have realized we don't have any reference to BuidlGuidl or any social link. Do you think could be interesting to add a Community section, that could have some of these links:
  • Link to scaffold-eth developers tg chat
  • Link to twitter for project updates (maybe bg + se twitter)
  • Youtube channel for guides / examples, maybe link to playlists
  • Built by buidlguidl? With link to the website

Docs website have all these community links in the footer, but was wondering if it would be handy to have (some of?) them here too. Also the fact that the repo is inside scaffold-eth makes me feel a reference to BuidlGuidl would be nice here.

But just throwing the ideas as they came to my mind, totally fine to ignore and keep it simple 🙏

[technophile-04]

Do you think we should add some kind of next steps (maybe could be simplified to a 1 liner to the website section) like we have in SE-2 Readme above documentation section

Ohh yeah I think one liner is worth it and makes sense having it 🙌

Have realized we don't have any reference to BuidlGuidl or any social link. Do you think could be interesting to add a Community section, that could have some of these links:

Ohh yeah maybe instead of having list with pointers maybe in the footer of the README we could have the link like this ??

Buidlguidl | SE-2 Website | Youtube

[rin-st]

Thanks for the suggestions!

Do you think we should add some kind of next steps (maybe could be simplified to a 1 liner to the website section) like we have in SE-2 Readme above documentation section

Added it!

Have realized we don't have any reference to BuidlGuidl or any social link. Do you think could be interesting to add a Community section, that could have some of these links:

Added community section this way for now:

Not sure which youtube links we should add.

Feel free to update the section if needed

[technophile-04]

Lgtm! Thanks Rinat!

Not sure which youtube links we should add.

Umm maybe link to Buidlguidl is doing the job we so don't it probably.

CC @Pabl0cks once, but this looks great to me!

[Pabl0cks]

CC @Pabl0cks once, but this looks great to me!

Yesterday I was trying to get some upgrades but wasn't happy enough to push them. Modified it a bit now, what do you think, is worth to change? Or some change feels forced?

Tried to set a link to youtube and bg website in places that could feel kind of natural, to simplify the footer just with community links.

I can push the changes if you feel it enhances current version, if not let's just merge current one! 🙏

[rin-st]

I like your changes!

[Pabl0cks]

I like your changes!

Pushed!

[technophile-04]

Thanks all 🙌

Just pushed a couple of commit :

7dc8a2b fixed the link, for some reason when I clicked earlier link it gave me this:

4cd63fc: removed the backlink to SE-2 github repo for contributing, we are moving towards create-eth being the main source of truth soon 🙌