Skip to content

Commit

Permalink
docs: Readme.md의 line-mode의 설명을 추가한다
Browse files Browse the repository at this point in the history
  • Loading branch information
devxb committed Apr 12, 2024
1 parent 061e96b commit 16a7e2e
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

##
<a href="https://github.com/devxb/gitanimals">
<img src="https://render.gitanimals.org/farms/devxb?mode=line" width="2000" height="60"/>
<img src="https://render.gitanimals.org/lines/devxb" width="2000" height="60"/>
</a>

<div align = "center">
Expand Down Expand Up @@ -52,7 +52,8 @@ farm mode는 갖고있는 모든 동물과 추가적인 정보를 보여줘요.
### line mode

line mode는 자신이 갖고있는 펫중 하나를 지정해서, 지정한 width, height범위에서 움직이게 해요.
펫이 Readme에서 자유롭게 움직이는모습을 표현할 수 있어요.
펫이 Readme에서 자유롭게 움직이는모습을 표현할 수 있어요.
pet-id에 아무값도 입력하지 않으면, 첫번째 펫이 가져와져요.
> [!TIP]
> **Img의 width와 height를 조절해서 펫의 이동영역을 조절할 수 있어요.**
> width를 길게 height를 작게하면 (width = 1000, height = 60) 가로로 길게 움직이게 할 수 있어요.
Expand All @@ -64,7 +65,17 @@ line mode는 자신이 갖고있는 펫중 하나를 지정해서, 지정한 wid

```html
<a href="https://github.com/devxb/gitanimals">
<img src = "https://render.gitanimals.org/farms/{username}?mode=line" width="1000" height="60"/>
<img src = "https://render.gitanimals.org/lines/{username}" width="1000" height="60"/>
</a>
```

펫은 다음 url을 웹에 요청 후, `$.personas.[].id` 에 해당하는 값을 url의 pet-id param에 입력하면서 변경할 수 있어요.
사용 가능한 펫을 확인하려면, `https://render.gitanimals.org/users/{username}` 을 url에 붙여넣으세요.
```html
예시)

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

Expand Down

0 comments on commit 16a7e2e

Please sign in to comment.