Skip to content

Commit b3e7278

Browse files
committed
update README.md
1 parent a91c737 commit b3e7278

File tree

1 file changed

+2
-20
lines changed

1 file changed

+2
-20
lines changed

README.md

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
<div align="center">
2-
<h2>🪄 GitHub Readme Tech Stack</h2>
2+
<h2>🪄 GitHub Readme Tech Stack 🪄</h2>
33
</div>
44

55
<div align="center">
6-
This project is currently under development, but a beta version is available. <br/>
76
Dynamically generated, customizable technologies cards for your GitHub README.
87
</div>
98

@@ -99,24 +98,7 @@ Here are the themes spread in a table. The card title is the name of the theme.
9998
</table>
10099

101100
### 📚 Adding a new theme
102-
Would you like to add a new theme to the list? You're lucky, every new theme is welcomed!
103-
It's actually pretty easy to add a new theme.
104-
105-
After following our contributing guidelines, you should have your own fork cloned locally. If so, search for the [themes.ts](https://github.com/0l1v3rr/github-readme-tech-stack/blob/master/src/cards/themes.ts) file. Please follow the code structure you see there.
106-
107-
You only have to specify a `set` method:
108-
```ts
109-
// the theme name should be snake_case
110-
themes.set("theme_name", {
111-
backgroundColor: "#ffffff", // the background color of the card
112-
borderColor: "#ffffff", // the border color of the card
113-
textColor: "#ffffff", // the text color inside the badge
114-
titleColor: "#ffffff", // the title color
115-
badgeColor: "#ffffff", // the background color of the badges
116-
});
117-
```
118-
> **Note**
119-
> Adding the theme to the README is not necessary.
101+
Would you like to add a new theme to the list? Check this [issue](https://github.com/0l1v3rr/github-readme-tech-stack/issues/2), please. **Thanks!**
120102

121103
<hr>
122104

0 commit comments

Comments
 (0)