Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@2jun0
2jun0 committed Jul 12, 2024
1 parent d1b789c commit 7c0f68c
Showing 1 changed file with 115 additions and 16 deletions.
131 changes: 115 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,134 @@
<a href="/README.md">english</a> · <a href="/docs/README_kr.md">한국어</a>
</div>


## Your Pokémon Collection
See [preivew](https://gitpokecol.org/static/preview.html)

Copy and paste this into your markdown or html.
Replace `{username}` with your GitHub username.

Moving left | Moving right
-------|---------
![2jun0's GitHub Pokemon Collection](https://gitpokecol.org/pokemons/2jun0?face=left) | ![2jun0's GitHub Pokemon Collection](https://gitpokecol.org/pokemons/2jun0?face=right)
Go [preivew](https://gitpokecol.org/static/preview.html) make your collection!

Or copy and paste this into your markdown or html.
Replace `{username}` with your GitHub username.

```
# Moving left
<a href="https://github.com/2jun0/github-pokemon-collection">
<img src="https://gitpokecol.org/pokemons/{username}?face=left" alt="{username}'s GitHub Pokemon Collection"/>
</a>
# Moving right
<a href="https://github.com/2jun0/github-pokemon-collection">
<img src="https://gitpokecol.org/pokemons/{username}?face=right" alt="{username}'s GitHub Pokemon Collection"/>
</a>
```

## Customization

You can customize your collection.

### Moving left or right

The default value is `left`.

```
https://gitpokecol.org/pokemons/{username}?face={left | right}
```

| Moving left | Moving right |
| --------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| ![Left Pokemon Collection](https://gitpokecol.org/pokemons/2jun0?face=left) | ![Right Pokemon Collection](https://gitpokecol.org/pokemons/2jun0?face=right) |

<details>
<summary>Show html tags</summary>
<div>

# Moving left
<a href="https://github.com/2jun0/github-pokemon-collection">
<img src="https://gitpokecol.org/pokemons/{username}?face=left" alt="{username}'s GitHub Pokemon Collection"/>
</a>
# Moving right
<a href="https://github.com/2jun0/github-pokemon-collection">
<img src="https://gitpokecol.org/pokemons/{username}?face=right" alt="{username}'s GitHub Pokemon Collection"/>
</a>

</div>
</details>

### Backgrounds

The default background is `none`.

```
https://gitpokecol.org/pokemons/{username}?background={ abyss | badlands | beach | cave | desert | normal | plain | none }
```

| abyss | badlands | beach | cave |
| ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| ![Abyss Pokemon Collection](https://gitpokecol.org/pokemons/2jun0?background=abyss) | ![Badlands Pokemon Collection](https://gitpokecol.org/pokemons/2jun0?background=badlands) | ![Beach Pokemon Collection](https://gitpokecol.org/pokemons/2jun0?background=beach) | ![Cave Pokemon Collection](https://gitpokecol.org/pokemons/2jun0?background=cave) |
| desert | normal | plain | none |
| ![Desert Pokemon Collection](https://gitpokecol.org/pokemons/2jun0?background=desert) | ![Normal Pokemon Collection](https://gitpokecol.org/pokemons/2jun0?background=normal) | ![Plain Pokemon Collection](https://gitpokecol.org/pokemons/2jun0?background=plain) | ![None Pokemon Collection](https://gitpokecol.org/pokemons/2jun0?background=none) |

<details>
<summary>Show html tags</summary>
<div>

# Background abyss
<a href="https://github.com/2jun0/github-pokemon-collection">
<img src="https://gitpokecol.org/pokemons/{username}?background=abyss" alt="{username}'s GitHub Pokemon Collection"/>
</a>
# Background badlands
<a href="https://github.com/2jun0/github-pokemon-collection">
<img src="https://gitpokecol.org/pokemons/{username}?background=badlands" alt="{username}'s GitHub Pokemon Collection"/>
</a>
# Background beach
<a href="https://github.com/2jun0/github-pokemon-collection">
<img src="https://gitpokecol.org/pokemons/{username}?background=beach" alt="{username}'s GitHub Pokemon Collection"/>
</a>
# Background cave
<a href="https://github.com/2jun0/github-pokemon-collection">
<img src="https://gitpokecol.org/pokemons/{username}?background=cave" alt="{username}'s GitHub Pokemon Collection"/>
</a>
# Background desert
<a href="https://github.com/2jun0/github-pokemon-collection">
<img src="https://gitpokecol.org/pokemons/{username}?background=desert" alt="{username}'s GitHub Pokemon Collection"/>
</a>
# Background normal
<a href="https://github.com/2jun0/github-pokemon-collection">
<img src="https://gitpokecol.org/pokemons/{username}?background=normal" alt="{username}'s GitHub Pokemon Collection"/>
</a>
# Background plain
<a href="https://github.com/2jun0/github-pokemon-collection">
<img src="https://gitpokecol.org/pokemons/{username}?background=plain" alt="{username}'s GitHub Pokemon Collection"/>
</a>
# Background none
<a href="https://github.com/2jun0/github-pokemon-collection">
<img src="https://gitpokecol.org/pokemons/{username}?background=none" alt="{username}'s GitHub Pokemon Collection"/>
</a>

</div>
</details>

### Width & Height

The default width is `300` and must be at least `250`.
and the default height is `250` and must be at least `200`.

```
https://gitpokecol.org/pokemons/{username}?width={width}&height={height}
```

![Big Pokemon Collection](https://gitpokecol.org/pokemons/2jun0?width=500&height=300)

<details>
<summary>Show html tag</summary>
<div>

<a href="https://github.com/2jun0/github-pokemon-collection">
<img src="https://gitpokecol.org/pokemons/{username}?width=500&height=300" alt="{username}'s GitHub Pokemon Collection"/>
</a>

</div>
</details>

## Commit Points (CP)
Commit Points that display as "cp" represent your total GitHub contributions.
As you commit 100 times, you will receive one Pokémon randomly.

Commit Points that display as "cp" represent your total GitHub contributions.
As you commit 100 times, you will receive one Pokémon randomly.
Pokémon are from Gen 1, with a total count of 151.

## Image Source
The sprites are from [www.pokencyclopedia.info](www.pokencyclopedia.info).

The sprites are from [www.pokencyclopedia.info](www.pokencyclopedia.info).
As [The License](/LICENSE.md) states, all Pokémon images are the property of Nintendo.

0 comments on commit 7c0f68c

Please sign in to comment.