docs: add readme

gitpokecol · Apr 26, 2024 · 39ec65b · 39ec65b
1 parent 367eac5
commit 39ec65b
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,30 @@
+<div align="center">
+    <h2 align="center">GitHub Pokémon Collection</h2>
+    <p align="center">Collect all Pokémon through GitHub contributions!</p>
+</div>
+<div align="center">
+    <a href="/README.md">english</a> · <a href="/docs/README_kr.md">한국어</a>
+</div>
+
+
+## Your Pokémon Collection
+
+Copy and paste this into your markdown or html.  
+Replace `{username}` with your GitHub username.
+
+![2jun0's GitHub Pokemon Collection](https://gitpokecol.org/pokemons/2jun0)
+
+```
+<a href="https://github.com/2jun0/github-pokemon-collection">
+  <img src="https://gitpokecol.org/pokemons/{username}/>
+</a>
+```
+
+## 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.  
+Pokémon are from Gen 1, with a total count of 151.
+
+## Image Source
+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.
diff --git a/docs/README_kr.md b/docs/README_kr.md
@@ -0,0 +1,35 @@
+<div align="center">
+    <h2 align="center">GitHub Pokémon Collection</h2>
+    <p align="center">GitHub 기여를 통해 모든 포켓몬을 모아보세요!</p>
+</div>
+<div align="center">
+    <a href="/README.md">english</a> · <a href="/docs/README_kr.md">한국어</a>
+</div>
+
+
+## 포켓몬 컬렉션
+마크다운 혹은 html에 아래를 복사하여 붙여넣으세요.  
+`{username}`칸은 여러분의 GitHub 유저명으로 바꿔주세요.
+
+![2jun0's GitHub Pokemon Collection](https://gitpokecol.org/pokemons/2jun0)
+
+```
+<a href="https://github.com/2jun0/github-pokemon-collection">
+  <img src="https://gitpokecol.org/pokemons/{username}/>
+</a>
+```
+
+이 레포로 링크되는 것이 싫으신 분은 이렇게 해도 됩니다!
+```
+![{username}'s GitHub Pokemon Collection](https://gitpokecol.org/pokemons/{username})
+```
+
+## 커밋 포인트 (CP)
+커밋 포인트는 "cp"로 표시되며 여러분의 총 GitHub 기여 수를 나타냅니다.  
+100번 커밋할 때마다 랜덤하게 포켓몬 한 마리를 받게 됩니다.  
+포켓몬은 근-본 1세대 중 하나이며 총 151마리입니다.
+
+
+## 이미지 출처
+스프라이트 이미지는 [www.pokencyclopedia.info](www.pokencyclopedia.info)에서 가져옵니다.  
+[라이선스](/LICENSE.md)에 따라, 모든 포켓몬 이미지의 저작권은 닌텐도에게 있습니다.