Skip to content

Commit 0790895

Browse files
LekoArtswardpeet
authored andcommitted
chore(gatsby): Update README (#33615)
1 parent 06760d7 commit 0790895

File tree

2 files changed

+32
-25
lines changed

2 files changed

+32
-25
lines changed

README.md

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

1010
<p align="center">
1111
⚛️ 📄 🚀
1212
</p>
1313
<p align="center">
1414
<strong>
15-
Fast in every way that matters
15+
Static. That. Scales.
1616
</strong>
1717
</p>
1818
<p align="center">
19-
Gatsby is a free and open source framework based on React that helps developers build blazing fast websites and apps
19+
Gatsby is a free and open source framework based on React that helps developers build blazing fast websites and apps. </br> It combines the control and scalability of dynamically rendered sites with the speed of static-site generation, creating a whole new web of possibilities.
2020
</p>
2121
<p align="center">
2222
<a href="https://github.com/gatsbyjs/gatsby/blob/master/LICENSE">
@@ -66,6 +66,8 @@ Gatsby is a modern web framework for blazing fast websites.
6666
limitations. Gatsby sites are fully functional React apps, so you can create high-quality,
6767
dynamic web apps, from blogs to e-commerce sites to user dashboards.
6868

69+
- **Choose your Rendering Option.** You can choose alternative [rendering options](https://gatsbyjs.com/docs/conceptual/rendering-options/), namely Deferred Static Generation (DSG) and Server-Side Rendering (SSR), in addition to Static Site Generation (SSG) — on a per-page basis. This type of granular control allows you to optimize for performance and productivity without sacrificing one for the other.
70+
6971
- **Use a Modern Stack for Every Site.** No matter where the data comes from, Gatsby sites are
7072
built using React and GraphQL. Build a uniform workflow for you and your team, regardless of
7173
whether the data is coming from the same backend.
@@ -88,6 +90,7 @@ Gatsby is a modern web framework for blazing fast websites.
8890

8991
- [Get Up and Running in 5 Minutes](#-get-up-and-running-in-5-minutes)
9092
- [Learning Gatsby](#-learning-gatsby)
93+
- [Release Notes](#-release-notes)
9194
- [Migration Guides](#-migration-guides)
9295
- [How to Contribute](#-how-to-contribute)
9396
- [License](#-license)
@@ -146,28 +149,28 @@ Wondering what we've shipped recently? Check out our [release notes](https://www
146149

147150
## 💼 Migration Guides
148151

149-
Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v3 to your site without starting from scratch!
152+
Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v4 to your site without starting from scratch!
150153

154+
- [Migrate from v3 to v4](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v3-to-v4/)
151155
- [Migrate from v2 to v3](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v2-to-v3/)
152-
- [Migrate from v1 to v2](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v1-to-v2/)
153156

154157
## ❗ Code of Conduct
155158

156159
Gatsby is dedicated to building a welcoming, diverse, safe community. We expect everyone participating in the Gatsby community to abide by our [**Code of Conduct**](https://www.gatsbyjs.com/contributing/code-of-conduct/). Please read it. Please follow it. In the Gatsby community, we work hard to build each other up and create amazing things together. 💪💜
157160

158161
## 🤝 How to Contribute
159162

160-
Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Gatsby community! :muscle::purple_heart:
163+
Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Gatsby community!
161164

162165
Check out our [**Contributing Guide**](https://www.gatsbyjs.com/contributing/how-to-contribute/) for ideas on contributing and setup steps for getting our repositories up and running on your local machine.
163166

164167
### A note on how this repository is organized
165168

166169
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.
167170

168-
### Contributing to Gatsby v2
171+
### Contributing to Gatsby v3
169172

170-
We are only accepting critical security patches for Gatsby v2.
173+
We are only accepting critical security patches for Gatsby v3.
171174

172175
## 📝 License
173176

packages/gatsby/README.md

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

10-
<h3 align="center">
10+
<p align="center">
1111
⚛️ 📄 🚀
12-
</h3>
13-
<h3 align="center">
14-
Fast in every way that matters
15-
</h3>
12+
</p>
13+
<p align="center">
14+
<strong>
15+
Static. That. Scales.
16+
</strong>
17+
</p>
1618
<p align="center">
17-
Gatsby is a free and open source framework based on React that helps developers build blazing fast websites and apps
19+
Gatsby is a free and open source framework based on React that helps developers build blazing fast websites and apps. </br> It combines the control and scalability of dynamically rendered sites with the speed of static-site generation, creating a whole new web of possibilities.
1820
</p>
1921
<p align="center">
2022
<a href="https://github.com/gatsbyjs/gatsby/blob/master/LICENSE">
@@ -40,7 +42,7 @@
4042
</a>
4143
</p>
4244

43-
<h3 align="center">
45+
<h2 align="center">
4446
<a href="https://www.gatsbyjs.com/docs/">Quickstart</a>
4547
<span> · </span>
4648
<a href="https://www.gatsbyjs.com/tutorial/">Tutorial</a>
@@ -56,14 +58,16 @@
5658
Support: <a href="https://twitter.com/AskGatsbyJS">Twitter</a>, <a href="https://github.com/gatsbyjs/gatsby/discussions">Discussions</a>
5759
<span> & </span>
5860
<a href="https://gatsby.dev/discord">Discord</a>
59-
</h3>
61+
</h2>
6062

6163
Gatsby is a modern web framework for blazing fast websites.
6264

6365
- **Go Beyond Static Websites.** Get all the benefits of static websites with none of the
64-
limitations. Gatsby sites are fully functional React apps so you can create high-quality,
66+
limitations. Gatsby sites are fully functional React apps, so you can create high-quality,
6567
dynamic web apps, from blogs to e-commerce sites to user dashboards.
6668

69+
- **Choose your Rendering Option.** You can choose alternative [rendering options](https://gatsbyjs.com/docs/conceptual/rendering-options/), namely Deferred Static Generation (DSG) and Server-Side Rendering (SSR), in addition to Static Site Generation (SSG) — on a per-page basis. This type of granular control allows you to optimize for performance and productivity without sacrificing one for the other.
70+
6771
- **Use a Modern Stack for Every Site.** No matter where the data comes from, Gatsby sites are
6872
built using React and GraphQL. Build a uniform workflow for you and your team, regardless of
6973
whether the data is coming from the same backend.
@@ -76,7 +80,7 @@ Gatsby is a modern web framework for blazing fast websites.
7680
splitting, image optimization, inlining critical styles, lazy-loading, prefetching resources,
7781
and more to ensure your site is fast — no manual tuning required.
7882

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

@@ -86,6 +90,7 @@ Gatsby is a modern web framework for blazing fast websites.
8690

8791
- [Get Up and Running in 5 Minutes](#-get-up-and-running-in-5-minutes)
8892
- [Learning Gatsby](#-learning-gatsby)
93+
- [Release Notes](#-release-notes)
8994
- [Migration Guides](#-migration-guides)
9095
- [How to Contribute](#-how-to-contribute)
9196
- [License](#-license)
@@ -99,7 +104,6 @@ You can get a new Gatsby site up and running on your local dev environment in 5
99104

100105
```shell
101106
npm install -g gatsby-cli
102-
103107
```
104108

105109
2. **Create a Gatsby site from a Gatsby starter.**
@@ -145,28 +149,28 @@ Wondering what we've shipped recently? Check out our [release notes](https://www
145149

146150
## 💼 Migration Guides
147151

148-
Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v3 to your site without starting from scratch!
152+
Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v4 to your site without starting from scratch!
149153

154+
- [Migrate from v3 to v4](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v3-to-v4/)
150155
- [Migrate from v2 to v3](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v2-to-v3/)
151-
- [Migrate from v1 to v2](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v1-to-v2/)
152156

153157
## ❗ Code of Conduct
154158

155159
Gatsby is dedicated to building a welcoming, diverse, safe community. We expect everyone participating in the Gatsby community to abide by our [**Code of Conduct**](https://www.gatsbyjs.com/contributing/code-of-conduct/). Please read it. Please follow it. In the Gatsby community, we work hard to build each other up and create amazing things together. 💪💜
156160

157161
## 🤝 How to Contribute
158162

159-
Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Gatsby community! :muscle::purple_heart:
163+
Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Gatsby community!
160164

161165
Check out our [**Contributing Guide**](https://www.gatsbyjs.com/contributing/how-to-contribute/) for ideas on contributing and setup steps for getting our repositories up and running on your local machine.
162166

163167
### A note on how this repository is organized
164168

165169
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.
166170

167-
### Contributing to Gatsby v2
171+
### Contributing to Gatsby v3
168172

169-
We are only accepting critical security patches for Gatsby v2.
173+
We are only accepting critical security patches for Gatsby v3.
170174

171175
## 📝 License
172176

0 commit comments

Comments
 (0)