Skip to content

Commit 7b6dd4d

Browse files
committed
update REAMDE.md
1 parent 8c30149 commit 7b6dd4d

File tree

1 file changed

+23
-41
lines changed

1 file changed

+23
-41
lines changed

README.md

Lines changed: 23 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,8 @@
2525

2626
<hr>
2727

28-
- [❓How do I use the card?](#how-do-i-use-the-card)
29-
- [🕹️ Customize the card](#️-customize-the-card)
30-
- [🔨 How to customize a line](#-how-to-customize-a-line)
28+
- [❓How do I create a card?](#how-do-i-create-a-card)
29+
- [🔨 Query parameters](#-query-parameters)
3130
- [🪁 Themes](#-themes)
3231
- [📚 Adding a new theme](#-adding-a-new-theme)
3332
- [🧠 Tips](#-tips)
@@ -40,18 +39,16 @@
4039

4140
<hr>
4241

43-
## ❓How do I use the card?
44-
It's pretty simple, just copy and paste this line of markdown:
45-
```md
46-
[![My Tech Stack](https://github-readme-tech-stack.vercel.app/api/cards)](https://github-readme-tech-stack.vercel.app/api/cards)
47-
```
42+
## ❓How do I create a card?
43+
Use [this](https://github-readme-tech-stack.vercel.app) website to customize a card for yourself. It's pretty straightforward.
44+
4845
> **Note**
49-
> This will create an empty card. You can customize this as you want. [Here](#️-customize-the-card) are the available options.
46+
> These cards use [shields.io](https://shields.io/) badges under the hood.
5047
5148
<hr>
5249

53-
## 🕹️ Customize the card
54-
Instead of building your card manually, please, use our [website](https://github-readme-tech-stack.vercel.app).
50+
## 🔨 Query parameters
51+
We suggest not editing the query parameters manually, use [our website](https://github-readme-tech-stack.vercel.app) instead.
5552

5653
| Parameter | Example | Default value | Description|
5754
|---------- |---------|---------------|------------|
@@ -63,30 +60,6 @@ Instead of building your card manually, please, use our [website](https://github
6360

6461
<hr>
6562

66-
## 🔨 How to customize a line
67-
Creating a line seems complicated, but it's very easy.
68-
69-
Lines are created of **badges**.
70-
Every badge is built like this: `{logoName},{logoTitle},{logoColor}` (e.g `typescript,typescript,2D79C7`).
71-
The `logoColor` has to be a hexadecimal color code, without the `#` symbol.
72-
We need to separate the values with commas. (`,`)
73-
74-
> **Note**
75-
> If you set the `logoColor` to `auto`, it will use the default color of the SVG logo.
76-
77-
Now that we know how to create badges, we can move on to creating a line.
78-
We just simply put badges next to each other separated by semicolons. (`{badge};{another one};{another one}`)
79-
80-
Congrats, you have successfully created your line of badges. Here is an example:
81-
```
82-
https://github-readme-tech-stack.vercel.app/api/cards?lineCount=1&line1=node.js,node.js,539E43;typescript,typescript,2D79C7;express,express.js,61DAFB
83-
```
84-
85-
> **Note**
86-
> These cards use [shields.io](https://shields.io/) badges under the hood.
87-
88-
<hr>
89-
9063
## 🪁 Themes
9164
Here are the themes spread in a table. The card title is the name of the theme.
9265

@@ -241,11 +214,11 @@ If you're using markdown, you may want to align your cards. There's an easy way
241214
```
242215

243216
### 🎭 Adding custom SVG logo
244-
Let's assume that you have a [line created](#-how-to-customize-a-line) and want to use your own SVGs. We support that using [Base64](https://en.wikipedia.org/wiki/Base64) format.
217+
We support this using [Base64](https://en.wikipedia.org/wiki/Base64) format.
245218
**[\*](https://stackoverflow.com/questions/38985050/how-do-i-use-the-logo-option-in-shields-io-badges) Here's an easy 3-step guide:**
246219
1. Download the image and use one of the many online tools, e.g. [http://b64.io/](http://b64.io/), to encode it.
247220
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.
248-
3. Finally, replace the first element of the badge (the `logoName`) with this string. (e.g `<Base64>,typescript,2D79C7;`)
221+
3. Finally, replace the first element of the badge (the `logoName`) with this string inside the URL. (e.g `<Base64>,typescript,2D79C7;`)
249222

250223
> **Note**
251224
> Sometimes the encoded string, of either step 2 or 3, may be too long to be used. You should then try to reduce the size (total pixels) of the image and try again.
@@ -257,18 +230,27 @@ If you don't have NodeJS, [download and install it](https://nodejs.org/en/).
257230
Then open a terminal and type these commands:
258231

259232
```sh
260-
# 1. Clone the project:
233+
# Clone the project:
261234
git clone https://github.com/0l1v3rr/github-readme-tech-stack.git
262235
cd github-readme-tech-stack
263236

264-
# 2. Install the dependencies:
237+
# Install the dependencies:
265238
npm i
266239

267-
# 3. Install husky (optional, but recommended)
240+
# Install husky (optional, but recommended)
268241
npm run prepare
269242

270-
# 4. Run the application:
243+
# Run the application:
271244
npm run dev
245+
246+
# -- Frontend:
247+
cd client
248+
249+
# Install the dependencies:
250+
npm i
251+
252+
# Run the application:
253+
npm start
272254
```
273255

274256
<hr>

0 commit comments

Comments
 (0)