Skip to content

Commit c502d28

Browse files
committed
docs: update grammar
1 parent 733104b commit c502d28

File tree

4 files changed

+28
-28
lines changed

4 files changed

+28
-28
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Contributing
22

3-
First of all, thanks for taking the time to contribute! Every contribution is welcomed.
3+
First of all, thank you for taking the time to contribute! Every contribution is appreciated.
44
Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved.
55

66
- [Contributing](#contributing)
77
- [Code of Conduct](#code-of-conduct)
88
- [Ways of contributing](#ways-of-contributing)
99
- [Issues](#issues)
1010
- [Found a bug?](#found-a-bug)
11-
- [Feature request, suggestion](#feature-request-suggestion)
11+
- [Feature Request, Suggestion](#feature-request-suggestion)
1212
- [Pull Request](#pull-request)
1313
- [Other ways](#other-ways)
1414
- [General information](#general-information)
@@ -17,43 +17,43 @@ Reading and following these guidelines will help us make the contribution proces
1717

1818
## Code of Conduct
1919

20-
By participating and contributing to this project, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
20+
By participating and contributing to this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
2121

2222
<hr>
2323

2424
## Ways of contributing
2525

26-
Contributions are made to this repository via **Issues** and **Pull Requests**.
26+
Contributions to this repository are made via **Issues** and **Pull Requests**.
2727

2828
### Issues
2929

3030
#### Found a bug?
3131

32-
Open an issue, where you describe the bug and explain how it occurred.
33-
Please, use an issue template, it guides you on how you should write your issue.
32+
Open a new issue describing the bug and how it occurred.
33+
Please use an issue template, it will guide you on how to write your issue.
3434

35-
#### Feature request, suggestion
35+
#### Feature Request, Suggestion
3636

37-
Here, you should use one of our issue templates as well.
38-
If you want to work on your suggestion as well, please, open an issue before you start working, so we know about it.
37+
Again, you should use one of our issue templates.
38+
If you want to work on your suggestion as well, please open an issue before you start working on it, so we know about it.
3939

4040
### Pull Request
4141

42-
If there's an issue you want to fix or develop, or you opened an issue as a feature request and want to work on the solution:
42+
If there's an issue you want to fix or develop, or if you've submitted an issue as a feature request and want to work on the solution:
4343

4444
1. Fork this repository
4545
2. Clone your fork
4646
3. Start working on your changes
4747
4. Commit and push your changes
48-
5. Open a Pull Request with the changes you made
48+
5. Open a Pull Request with your changes
4949

5050
### Other ways
5151

52-
If you currently don't have any ideas in mind but want to support the project:
52+
If you don't have any ideas yet, but want to support the project:
5353

5454
1. Add a GitHub star to this project
5555
2. Tweet about the project
56-
3. Write a review or a blog article about the project
56+
3. Write a review or blog post about the project
5757

5858
<hr>
5959

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
</div>
1919

2020
<div align="center">
21-
Display your favorite technologies, tools, or the tech stack your project uses with these fully customizable, good-looking cards on your GitHub README!
21+
Show off your favorite technologies, tools, or the tech stack your project uses with these fully customizable, great-looking cards on your GitHub README!
2222
</div>
2323

2424
<br>
@@ -46,7 +46,7 @@
4646
<hr>
4747

4848
## ⚡ Quick Start
49-
The easiest way to start using these cards is to visit our website, where you can customize your card with a live preview.
49+
The easiest way to get started is to visit our website, where you can customize and preview your card live.
5050
[https://github-readme-tech-stack.vercel.app](https://github-readme-tech-stack.vercel.app)
5151

5252
<p align="center">
@@ -56,7 +56,7 @@ The easiest way to start using these cards is to visit our website, where you ca
5656
<hr>
5757

5858
## 🔧 Query parameters
59-
None of the fields are required. Every query parameter has a default value displayed below.
59+
None of the fields are required. Each query parameter has a default value, which is listed below.
6060

6161
| Parameter | Example | Default value | Description |
6262
|---------- |---------|---------------|------------ |
@@ -80,15 +80,15 @@ None of the fields are required. Every query parameter has a default value displ
8080
<hr>
8181

8282
## 🪁 Themes
83-
These cards come with several built-in themes you can use. You can find all of them by clicking [here](docs/THEMES.md).
84-
If you have a cool new theme in mind, or add one for yourself and others, please check [#45](https://github.com/0l1v3rr/github-readme-tech-stack/issues/45)
83+
These cards come with several built-in themes that you can use. You can find them all by clicking [here](docs/THEMES.md).
84+
If you have a cool new theme in mind, or want to add one for yourself and others, please see [#45](https://github.com/0l1v3rr/github-readme-tech-stack/issues/45).
8585

8686
### 🖌 Customizing a theme
87-
You can customize a theme using these query parameters.
88-
These parameters accept only valid hexadecimal colors, otherwise, they are not applied. Please use `%23` instead of `#`.
87+
These query parameters allow you to customize a theme.
88+
These parameters only accept valid hexadecimal colors, otherwise they will not be applied. Please use `%23` instead of `#`.
8989

9090
> **Warning**
91-
> If the `?theme=` parameter is specified, any of these color customizations will override the theme's values.
91+
> If the `?theme=` parameter is specified, any of these color adjustments will override the theme values.
9292
9393
| Parameter | Example | Description |
9494
|-----------|---------|-------------|
@@ -102,7 +102,7 @@ These parameters accept only valid hexadecimal colors, otherwise, they are not a
102102
## 🧠 Tips
103103

104104
### 🪢 Align the card in the markdown
105-
If you're using markdown, you may want to align your cards. There's an easy way to do it with the align attribute:
105+
If you're using markdown, you may want to align your cards. There's an easy way to do this with the align attribute:
106106
```html
107107
<img align="center" src="https://github-readme-tech-stack.vercel.app/api/cards" alt="My Tech Stack" />
108108
```
@@ -135,7 +135,7 @@ We support this using [Base64](https://en.wikipedia.org/wiki/Base64) format.
135135

136136
## ⚒️ Building from source
137137
If you don't have NodeJS, [download and install it](https://nodejs.org/en/).
138-
Then open a terminal and type these commands:
138+
Then open a terminal and type the following commands:
139139

140140
**Backend:**
141141
```sh
@@ -165,9 +165,9 @@ npm start
165165
<hr>
166166

167167
## 🧑‍🤝‍🧑 Contributing
168-
Every contribution is welcomed.
168+
All contributions are welcome.
169169
You can find a contributing guideline [here](CONTRIBUTING.md).
170-
This project is licensed under the [MIT License](LICENSE).
170+
This project is released under the [MIT License](LICENSE).
171171

172172
<hr>
173173

client/public/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1" />
77
<meta
88
name="description"
9-
content="Display your favorite technologies, tools, or the tech stack your project uses with these fully customizable, good-looking cards on your GitHub README!"
9+
content="Show off your favorite technologies, tools, or the tech stack your project uses with these fully customizable, great-looking cards on your GitHub README!"
1010
/>
1111
<meta http-equiv="Cache-Control" content="no-store, no-cache" />
1212
<meta http-equiv="Pragma" content="no-cache" />

docs/THEMES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Supported themes
22

3-
Here are the currently supported themes spread in a table.
4-
If you have a cool new theme in mind, or add one for yourself and others, please check [#45](https://github.com/0l1v3rr/github-readme-tech-stack/issues/45)
3+
Here is a table of currently supported themes.
4+
If you have a cool new theme in mind, or want to add one for yourself and others, please see [#45](https://github.com/0l1v3rr/github-readme-tech-stack/issues/45).
55

66
<table>
77
<tr>

0 commit comments

Comments
 (0)