Skip to content

Commit 45257d5

Browse files
committed
Update README
1 parent 1e1b8b2 commit 45257d5

File tree

3 files changed

+22
-14
lines changed

3 files changed

+22
-14
lines changed

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,20 @@
44

55
## What is it?
66

7-
A simple but nice header image generator for your Github profile Readme. [Website Link](https://leviarista.github.io/github-profile-header-generator/).
7+
A simple but nice header image generator for your Github profile Readme.
8+
You can use it for your repo banners too!
9+
10+
[Create my banner!](https://leviarista.github.io/github-profile-header-generator/)
811

912
## How to use it?
10-
1. Create a nice github header image.
13+
14+
1. Create a nice github header image.
1115
2. Create your GitHub profile README following [this guide](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme).
1216
3. Upload your header to your profile repo.
13-
4. Add this line to your README:
14-
```` Markdown
15-
![Header](./[Your header image])
16-
````
17+
4. Add this line to your README:
18+
```Markdown
19+
![Header](./[Your header image])
20+
```
1721

1822
## Examples
1923

@@ -34,23 +38,27 @@ A simple but nice header image generator for your Github profile Readme. [Websit
3438
- Set background pattern image, its color, size and opacity.
3539
- Add decorations.
3640
- Upload your own decoration, octocat or profile pic.
37-
- Toogle Github dark and light mode.
41+
- Toogle between Github dark and light mode.
3842
- Download image as png.
39-
- Randomize between predefined themes.
43+
- Choose from predefined presets or get a random one.
4044

4145
## Tech used
4246

4347
- [Vite](https://vitejs.dev/)
44-
- [html2canvas](https://html2canvas.hertzen.com/)
48+
- [snapdom](https://zumerlab.github.io/snapdom/)
4549

4650
## Get started
4751

48-
- `npm run dev`- starts dev server
49-
- `npm run build` - builds for production
50-
- `npm run preview` - locally previews production build
52+
- `npm run dev`- starts dev server
53+
- `npm run build` - builds for production
54+
- `npm run preview` - locally previews production build
5155

5256
## Get started with Docker
5357

5458
```bash
5559
docker-compose up -d --build --force-recreate
5660
```
61+
62+
## Contributing
63+
64+
Check out our [Contributing guide](https://github.com/leviarista/github-profile-header-generator/blob/main/.github/CONTRIBUTING.md)

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
<div class="tab">
1717
<button class="tablinks" data-name="presets-section">
18-
Themes
18+
Presets
1919
<div
2020
style="position: absolute; background-color: rgba(255, 255, 255, 1); top: 5px; color: #585c9c; padding: 2px 5px; font-size: 10px; font-weight: bold; border-radius: 5px; transform: translateX(-40px)">
2121
NEW

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "github-profile-header-generator",
3-
"version": "2.0.0",
3+
"version": "2.1.0",
44
"description": "A simple but nice header image generator for your Github profile",
55
"scripts": {
66
"dev": "vite",

0 commit comments

Comments
 (0)