Skip to content

Commit 85bb2fa

Browse files
IyaadArshadDhairyaMajmudargregsdennis
authored
Improvements: Typos and grammatical errors in README.md (#1081)
* Improved README.md Fixed some typos, grammatical errors and added extra info in places for extra clarity * Replaced word to suggestion Co-authored-by: Dhairya Majmudar <[email protected]> * Update README.md * Update README.md Co-authored-by: Greg Dennis <[email protected]> * Update README.md Co-authored-by: Greg Dennis <[email protected]> * Resolved benjam's review * Small Tweaks to README.md to improve clarity --------- Co-authored-by: Dhairya Majmudar <[email protected]> Co-authored-by: Greg Dennis <[email protected]>
1 parent f3f8507 commit 85bb2fa

File tree

1 file changed

+28
-26
lines changed

1 file changed

+28
-26
lines changed

README.md

+28-26
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@
2020
</p>
2121

2222
# 👋 Welcome to the JSON Schema website
23-
This repository contains the sources of JSON Schema website:
23+
This repository contains the source code of the JSON Schema website:
2424

25-
* It's powered by Next.js,
26-
* It uses Tailwind CSS framework,
27-
* It's build and deployed with Netlify.
25+
* Powered by Next.js,
26+
* Uses the Tailwind CSS framework,
27+
* Built and deployed with Netlify.
2828

29-
## Setting up Project
29+
## Setting up the Project
3030

31-
Please refer to the [INSTALLATION.md](./INSTALLATION.md) file for instructions on how to set up the project on your local machine.
31+
Please refer to [INSTALLATION.md](./INSTALLATION.md) for instructions on how to set up the project for local development.
3232

3333
## Project structure
3434

@@ -37,41 +37,42 @@ This repository has the following structure:
3737
<!-- If you make any changes in the project structure, remember to update it. -->
3838

3939
```text
40-
├── .github # Definitions of GitHub workflows, pull request and issue templates
40+
├── .github # Definitions of GitHub workflows, pull request, and issue templates
4141
├── components # Various generic components such as "Button", "Figure", etc.
42-
├── data # JSON Schema Implementations.
42+
├── data # JSON Schema implementations
4343
├── styles # Various CSS files
44-
├── lib # Various JS code for preparing static data to render in pages
45-
├── pages # Website's pages source. It includes raw markdown files and React page templates.
44+
├── lib # Various JS code for preparing static data to render on pages
45+
├── pages # Website's pages source, including raw markdown files and React page templates
4646
│ ├── overview # JSON Schema initiative docs
4747
│ ├── blog # Blog posts
4848
│ ├── learn # JSON Schema docs
4949
│ └── implementations # Various pages to describe tools
50-
├── public # Data for site metadata and static blog such as images
50+
├── public # Data for site metadata and static assets such as images
5151
├── next.config.js # Next.js configuration file
5252
5353
```
5454

5555
## Contribute
56-
5756
Here are some areas where you can contribute to the website:
58-
- Blogs posts
59-
- Case Studies
57+
58+
- Blog posts
59+
- Case studies
6060
- Design
61-
- Documentation
61+
- Documentation improvements
6262
- Website enhancements
63-
- Add a new JSON Schema Implementation
63+
- Add a new JSON Schema implementation
6464
- JSON Schema Landscape
6565

66-
To figure out a good first issue to work on, join our Slack workspace and visit the `#contribute` channel. This channel is specifically designed for onboarding and supporting new contributors.
66+
To identify good first issues to work on, join our Slack workspace and visit the `#contribute` channel. This channel is specifically designed for onboarding and supporting new contributors.
6767

6868
You should also check out our [Contributing guidelines](./CONTRIBUTING.md).
6969

7070
### Contributors
7171

72-
Thanks goes to these wonderful people who contributed to this website:
73-
<a href = "https://github.com/json-schema-org/website/graphs/contributors">
74-
<img src = "https://contrib.rocks/image?repo=json-schema-org/website"/>
72+
Thanks to these wonderful people who contributed to this website:
73+
<br />
74+
<a href="https://github.com/json-schema-org/website/graphs/contributors">
75+
<img src="https://contrib.rocks/image?repo=json-schema-org/website"/>
7576
</a>
7677

7778
<sub>Made with [contributors-img](https://contrib.rocks).</sub>
@@ -83,19 +84,20 @@ Thanks goes to these wonderful people who contributed to this website:
8384
### Backers
8485

8586
**Thank you to all our backers!**
87+
8688
[![Backers](https://opencollective.com/json-schema/backers.svg)](https://opencollective.com/json-schema/backers.svg?avatarHeight=90)
8789

8890
## Connect with the JSON Schema Community
8991

9092
<p align="left">
91-
<a href="https://json-schema.org/slack" target="blank" style="margin-right: 5px;"><img align="center" src="https://img.icons8.com/color/48/null/slack-new.png" alt="JSON Schema Slack" height="30" width="40" /></a>
92-
<a href="https://x.com/jsonschema" target="blank" style="margin-right: 5px;"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/twitter.svg" alt="JSON Schema Twitter" height="30" width="40" /></a>
93-
<a href="https://www.linkedin.com/company/jsonschema" target="blank" style="margin-right: 5px;"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/linked-in-alt.svg" alt="JSON Schema LinkedIn" height="30" width="40" /></a>
94-
<a href="https://www.youtube.com/@JSONSchemaOrgOfficial" target="blank"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/youtube.svg" alt="JSON Schema YouTube" height="30" width="40" /></a>
93+
<a href="https://json-schema.org/slack" target="_blank" style="margin-right: 5px;"><img align="center" src="https://img.icons8.com/color/48/null/slack-new.png" alt="JSON Schema Slack" height="30" width="auto" /></a>
94+
<a href="https://twitter.com/jsonschema" target="_blank" style="margin-right: 5px;"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/twitter.svg" alt="JSON Schema Twitter" height="30" width="auto" /></a>
95+
<a href="https://www.linkedin.com/company/jsonschema" target="_blank" style="margin-right: 5px;"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/linked-in-alt.svg" alt="JSON Schema LinkedIn" height="30" width="auto" /></a>
96+
<a href="https://www.youtube.com/@JSONSchemaOrgOfficial" target="_blank"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/youtube.svg" alt="JSON Schema YouTube" height="30" width="auto" /></a>
9597
</p>
9698

9799
## Inspired by
98-
This document has been inspired by [AsyncAPI website README.md](https://github.com/asyncapi/website/blob/master/README.md).
100+
This document was inspired by [AsyncAPI website README.md](https://github.com/asyncapi/website/blob/master/README.md).
99101

100102
## License
101-
The contents of this repository are [licensed under](./LICENSE) either the BSD 3-clause license *or* the Academic Free License v3.0.
103+
The contents of this repository are licensed under either the BSD 3-clause license *or* the Academic Free License v3.0. See [LICENSE](./LICENSE).

0 commit comments

Comments
 (0)