아래의 링크를 깃허브 Readme 에 붙여넣기 하는것으로 쉽게 적용할 수 있어요.

line mode는 자신이 가지고 있는 펫중 하나를 지정해서, 지정한 width, height범위에서 움직이게 해요.
line mode를 사용할때, markdown 방식으로 이미지를 요청하면, width, height를 설정할 수 없어서 펫이 보이지 않을 수 있으니, HTML방식을 사용해 주세요.

<a href="https://github.com/devxb/gitanimals">
 <img src="https://render.gitanimals.org/lines/{username}?pet-id=1" width="1000" height="120"/>
</a>

pet-id에 아무값도 입력하지 않으면, 첫번째 펫이 가져와져요.

변경 가능한 pet-id는 https://render.gitanimals.org/users/{username} 의 {username}을 자신의 깃허브 아이디로 변경 후 API를 요청하면 확인할 수 있어요.
API 응답의 $.personas.[].id 에 해당하는 값을 pet-id에 입력하면 돼요.

lines모드에서는 펫 레벨 위에 총 contributions수를 보여줘요. 원하지 않을 경우, 쿼리 파라미터로 contribution-view=false를 담아 요청하세요.

farm mode는 가지고 있는 모든 동물과 추가적인 정보를 보여줘요.

html

<a href="https://github.com/devxb/gitanimals">
 <img src="https://render.gitanimals.org/farms/{username}"/>
</a>

길드를 만들고 친구와 함께 펫을 키울 수 있어요.
길드 만들러 가기

html

<a href="https://github.com/devxb/gitanimals">
 <img src="https://render.gitanimals.org/guilds/{guildId}/draw"/>
</a>

펫은 다음 두가지 방법으로 획득할 수 있어요.

1. 커밋 30번하기
   커밋이 30번 누적되면 새로운 펫이 등장해요. 이때, 모든 펫들은 등장하는 확률이 달라요.
   이때, 최대로 얻을 수 있는 펫은 30개 입니다. 30개가 넘는 펫은 인벤토리로 들어가며, 홈페이지에서 언제든지 보여지는 펫과 교체할 수 있어요.
2. 펫 구매하기
   다른 유저가 판매하는 펫을 커밋포인트로 구매할 수 있어요.
   커밋 1회당 일정량의 포인트가 지급됩니다. 혹은 자신의 펫을 판매해서 커밋포인트를 얻을수도 있어요.

Total contribtuions는 깃허브에 가입 후 집계된 Contribtuions의 총합이에요.
새로운 contribution 반영은 최대 1시간이 소요될 수 있어요.