Skip to content

Commit 9ede572

Browse files
authored
Merge pull request #32 from ShashwatAgrawal20/readme-gif
docs: added animated gif
2 parents e5d843c + d5de752 commit 9ede572

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,12 @@
3636
<hr>
3737

3838
## ⚡ Quick Start
39-
The easiest way to start using these cards is to visit our website, where you can customize your card with a live preview.
39+
The easiest way to start using these cards is to visit our website, where you can customize your card with a live preview.
4040
[https://github-readme-tech-stack.vercel.app](https://github-readme-tech-stack.vercel.app)
4141

42-
<img src="./docs/demo-site-2.png" alt="">
42+
<p align="center">
43+
<img src="./docs/github-readme-tech-stack.gif" alt="tutorial">
44+
</p>
4345

4446
<hr>
4547

@@ -61,7 +63,7 @@ None of the fields are required. Every query parameter has a default value displ
6163
<hr>
6264

6365
## 🪁 Themes
64-
These cards come with several built-in themes you can use. You can find all of them by clicking [here](docs/THEMES.md).
66+
These cards come with several built-in themes you can use. You can find all of them by clicking [here](docs/THEMES.md).
6567
If you would like to use other themes, and add one for yourself and others, please check this [issue](https://github.com/0l1v3rr/github-readme-tech-stack/issues/2).
6668

6769
<hr>
@@ -86,7 +88,7 @@ You can use [GitHub's new feature](https://github.blog/changelog/2022-05-19-spec
8688

8789
```html
8890
<picture>
89-
<source
91+
<source
9092
srcset="https://github-readme-tech-stack.vercel.app/api/cards?theme=github_dark&lineCount=1&line1=typescript,typescript,auto"
9193
media="(prefers-color-scheme: dark)"
9294
/>
@@ -99,7 +101,7 @@ You can use [GitHub's new feature](https://github.blog/changelog/2022-05-19-spec
99101
```
100102

101103
### 🎭 Adding custom SVG logo
102-
We support this using [Base64](https://en.wikipedia.org/wiki/Base64) format.
104+
We support this using [Base64](https://en.wikipedia.org/wiki/Base64) format.
103105
**[\*](https://stackoverflow.com/questions/38985050/how-do-i-use-the-logo-option-in-shields-io-badges) Here's an easy 3-step guide:**
104106
1. Download the SVG and use one of the many online tools, e.g. [http://b64.io/](http://b64.io/), to encode it.
105107
2. Encode the Base64 string in [percent-encoding](https://en.wikipedia.org/wiki/Percent-encoding). Take the Base64 string and use one of the many online tools, e.g. [http://meyerweb.com/eric/tools/dencoder/](http://meyerweb.com/eric/tools/dencoder/), to encode the string.
@@ -108,7 +110,7 @@ We support this using [Base64](https://en.wikipedia.org/wiki/Base64) format.
108110
<hr>
109111

110112
## ⚒️ Building from source
111-
If you don't have NodeJS, [download and install it](https://nodejs.org/en/).
113+
If you don't have NodeJS, [download and install it](https://nodejs.org/en/).
112114
Then open a terminal and type these commands:
113115

114116
**Backend:**
@@ -139,8 +141,8 @@ npm start
139141
<hr>
140142

141143
## 🧑‍🤝‍🧑 Contributing
142-
Every contribution is welcomed.
143-
You can find a contributing guideline [here](CONTRIBUTING.md).
144+
Every contribution is welcomed.
145+
You can find a contributing guideline [here](CONTRIBUTING.md).
144146
This project is licensed under the [MIT License](LICENSE).
145147

146148
<hr>

docs/github-readme-tech-stack.gif

2.23 MB
Loading

0 commit comments

Comments
 (0)