Skip to content

Commit 5e8e621

Browse files
authored
chore: Update main README (#36954)
1 parent 7130cd4 commit 5e8e621

File tree

2 files changed

+28
-50
lines changed

2 files changed

+28
-50
lines changed

README.md

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,12 @@
44
</a>
55
</p>
66
<h1 align="center">
7-
Gatsby v4
7+
Gatsby
88
</h1>
99

10-
<p align="center">
11-
⚛️ 📄 🚀
12-
</p>
1310
<p align="center">
1411
<strong>
15-
Static. That. Scales.
12+
The future of web development is here.
1613
</strong>
1714
</p>
1815
<p align="center">
@@ -74,6 +71,8 @@ Gatsby helps professional developers efficiently create maintainable, highly-per
7471

7572
- **Host at Scale for Pennies.** Gatsby sites don’t require servers, so you can host your entire site on a CDN for a fraction of the cost of a server-rendered site. Many Gatsby sites can be hosted entirely free on [Gatsby Cloud](https://www.gatsbyjs.com/cloud/) and other similar services.
7673

74+
- **Use Gatsby's Centralized Data Layer Everywhere.** With Gatsby's [Valhalla Content Hub](https://www.gatsbyjs.com/products/valhalla-content-hub/) you can bring Gatsby's data layer to any project. Making it accessible via a unified GraphQL API for building content sites, eCommerce platforms, and both native and web applications.
75+
7776
[**Learn how to use Gatsby for your next project.**](https://www.gatsbyjs.com/docs/)
7877

7978
## 🚀 Ship your first Gatsby site in 5 Minutes
@@ -88,36 +87,28 @@ At the end of this process, you'll have
8887
2. a new repository that is linked to that new site
8988
3. as you push changes to your new repository, Gatsby Cloud will automatically rebuild and redeploy your site!
9089

91-
## 💻 Get started with Gatsby _locally_ in 5 Minutes
90+
## 💻 Get started with Gatsby locally in 5 Minutes
9291

9392
You can get a new Gatsby site up and running on your local dev environment in 5 minutes with these four steps:
9493

95-
1. **Install the Gatsby CLI.**
94+
1. **Initialize a new project.**
9695

9796
```shell
98-
npm install -g gatsby-cli
97+
npm init gatsby
9998
```
10099

101-
2. **Create a Gatsby site from a Gatsby starter.**
100+
Give it the name "My Gatsby Site".
102101

103-
Get your Gatsby blog set up in a single command:
104-
105-
```shell
106-
# Create a new Gatsby site using the interactive setup wizard
107-
# Give it this name: My Gatsby site
108-
gatsby new
109-
```
110-
111-
3. **Start the site in `develop` mode.**
102+
2. **Start the site in `develop` mode.**
112103

113104
Next, move into your new site’s directory and start it up:
114105

115106
```shell
116107
cd my-gatsby-site/
117-
gatsby develop
108+
npm run develop
118109
```
119110

120-
4. **Open the source code and start editing!**
111+
3. **Open the source code and start editing!**
121112

122113
Your site is now running at `http://localhost:8000`. Open the `my-gatsby-site` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes, and the browser will update in real time!
123114

@@ -143,8 +134,9 @@ Also, read our [documentation on version support](https://www.gatsbyjs.com/docs/
143134

144135
## 💼 Migration Guides
145136

146-
Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v4 to your site without starting from scratch!
137+
Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v5 to your site without starting from scratch!
147138

139+
- [Migrate from v4 to v5](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v4-to-v5/)
148140
- [Migrate from v3 to v4](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v3-to-v4/)
149141
- [Migrate from v2 to v3](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v2-to-v3/)
150142

@@ -162,10 +154,6 @@ Check out our [**Contributing Guide**](https://www.gatsbyjs.com/contributing/how
162154

163155
This repository is a [monorepo](https://trunkbaseddevelopment.com/monorepos/) managed using [Lerna](https://github.com/lerna/lerna). This means there are [multiple packages](https://github.com/gatsbyjs/gatsby/tree/master/packages) managed in this codebase, even though we publish them to NPM as separate packages.
164156

165-
### Contributing to Gatsby v3
166-
167-
We are only accepting critical security patches for Gatsby v3.
168-
169157
## 📝 License
170158

171159
Licensed under the [MIT License](./LICENSE).

packages/gatsby/README.md

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,12 @@
44
</a>
55
</p>
66
<h1 align="center">
7-
Gatsby v4
7+
Gatsby
88
</h1>
99

10-
<p align="center">
11-
⚛️ 📄 🚀
12-
</p>
1310
<p align="center">
1411
<strong>
15-
Static. That. Scales.
12+
The future of web development is here.
1613
</strong>
1714
</p>
1815
<p align="center">
@@ -74,6 +71,8 @@ Gatsby helps professional developers efficiently create maintainable, highly-per
7471

7572
- **Host at Scale for Pennies.** Gatsby sites don’t require servers, so you can host your entire site on a CDN for a fraction of the cost of a server-rendered site. Many Gatsby sites can be hosted entirely free on [Gatsby Cloud](https://www.gatsbyjs.com/cloud/) and other similar services.
7673

74+
- **Use Gatsby's Centralized Data Layer Everywhere.** With Gatsby's [Valhalla Content Hub](https://www.gatsbyjs.com/products/valhalla-content-hub/) you can bring Gatsby's data layer to any project. Making it accessible via a unified GraphQL API for building content sites, eCommerce platforms, and both native and web applications.
75+
7776
[**Learn how to use Gatsby for your next project.**](https://www.gatsbyjs.com/docs/)
7877

7978
## 🚀 Ship your first Gatsby site in 5 Minutes
@@ -88,36 +87,28 @@ At the end of this process, you'll have
8887
2. a new repository that is linked to that new site
8988
3. as you push changes to your new repository, Gatsby Cloud will automatically rebuild and redeploy your site!
9089

91-
## 💻 Get started with Gatsby _locally_ in 5 Minutes
90+
## 💻 Get started with Gatsby locally in 5 Minutes
9291

9392
You can get a new Gatsby site up and running on your local dev environment in 5 minutes with these four steps:
9493

95-
1. **Install the Gatsby CLI.**
94+
1. **Initialize a new project.**
9695

9796
```shell
98-
npm install -g gatsby-cli
97+
npm init gatsby
9998
```
10099

101-
2. **Create a Gatsby site from a Gatsby starter.**
102-
103-
Get your Gatsby blog set up in a single command:
104-
105-
```shell
106-
# Create a new Gatsby site using the interactive setup wizard
107-
# Give it this name: My Gatsby site
108-
gatsby new
109-
```
100+
Give it the name "My Gatsby Site".
110101

111-
3. **Start the site in `develop` mode.**
102+
2. **Start the site in `develop` mode.**
112103

113104
Next, move into your new site’s directory and start it up:
114105

115106
```shell
116107
cd my-gatsby-site/
117-
gatsby develop
108+
npm run develop
118109
```
119110

120-
4. **Open the source code and start editing!**
111+
3. **Open the source code and start editing!**
121112

122113
Your site is now running at `http://localhost:8000`. Open the `my-gatsby-site` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes, and the browser will update in real time!
123114

@@ -139,10 +130,13 @@ We welcome suggestions for improving our docs. See the [“how to contribute”]
139130

140131
Wondering what we've shipped recently? Check out our [release notes](https://www.gatsbyjs.com/docs/reference/release-notes) for key highlights, performance improvements, new features, and notable bugfixes.
141132

133+
Also, read our [documentation on version support](https://www.gatsbyjs.com/docs/reference/release-notes/gatsby-version-support/) to understand our plans for each version of Gatsby.
134+
142135
## 💼 Migration Guides
143136

144-
Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v4 to your site without starting from scratch!
137+
Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v5 to your site without starting from scratch!
145138

139+
- [Migrate from v4 to v5](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v4-to-v5/)
146140
- [Migrate from v3 to v4](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v3-to-v4/)
147141
- [Migrate from v2 to v3](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v2-to-v3/)
148142

@@ -160,10 +154,6 @@ Check out our [**Contributing Guide**](https://www.gatsbyjs.com/contributing/how
160154

161155
This repository is a [monorepo](https://trunkbaseddevelopment.com/monorepos/) managed using [Lerna](https://github.com/lerna/lerna). This means there are [multiple packages](https://github.com/gatsbyjs/gatsby/tree/master/packages) managed in this codebase, even though we publish them to NPM as separate packages.
162156

163-
### Contributing to Gatsby v3
164-
165-
We are only accepting critical security patches for Gatsby v3.
166-
167157
## 📝 License
168158

169159
Licensed under the [MIT License](./LICENSE).

0 commit comments

Comments
 (0)