올바른 리드미 작성법
📌 리드미란?
리드미란, 다른 사람에게 나의 프로젝트가 얼마나 유용한지를 설명하기 위한 소개글이다.
- 이 프로젝트를 가지고 무엇을 할 수 있는지?
- 프로젝트를 어떻게 사용할 수 있는지?
위 두가지를 목적으로 작성하는 것이 바로 리드미이다.
💡 좋은 리드미 작성법
기본만 잘 따라도 좋은 리드미처럼 보일 수 있다.
- 프로젝트가 하는 일
- 프로젝트가 유용한 이유
- 프로젝트 시작하는 방법
- 프로젝트에 대한 도움을 받을 수 있는 곳
- 프로젝트를 유지하고 기여하는 사람
위 5가지가 github에서 언급하는 리드미 작성에 포함되어야 할 정보이다.
💼 오늘 할 일
[x] 리드미 작성 기준에 맞게 리드미 작성하기
위 예시는 내가 과제 제출을 위해 처음에 적었던 리드미이다. 이 리드미를 좋은 리드미 작성법에 맞게 개선해보자.
1. 프로젝트가 하는 일
이 프로젝트는 사용자가 다양한 상태의 업로드 버튼 UI가 필요할 때, 재사용 가능한 컴포넌트를 제공하는 프로젝트이다.
2. 프로젝트가 유용한 이유
- 재사용이 가능한 업로드 버튼 UI를 사용할 수 있습니다.
- 기본 제공되는 버튼 UI가 훌륭합니다.
3. 프로젝트 시작하는 방법
UploadButton
기본적인 사용법은 다음과 같습니다.
1 | <UploadButton type="idle">업로드</UploadButton> |
타입 설정
아래의 타입을 설정하면 다음과 같은 모양의 버튼 UI가 생성됩니다.
| type | shape |
|---|---|
| idle |  |
| pending |  |
| resolved |  |
| rejected |  |
| disabled |  |
4. 프로젝트에 대해 도움 받을 수 있는 곳
만약 프로젝트에 대해 도움이 필요하시다면 아래 이메일로 연락을 주세요!
5. 프로젝트를 유지하고 기여하는 사람
| https://github.com/loco9939 |
|---|
 |
⭐️ 결과
https://github.com/loco9939/zero-base/tree/icon-upload-button/complete
🏓 소감
리드미란 처음 내 프로젝트를 다른 사람에게 알리는 첫 게시물이므로 사람들이 내 프로젝트를 어떻게 하면 편리하게 사용할 수 있을지, 또 사용하고 싶도록 만들지를 생각하면서 작성해야하는 것을 알게되었다.
이것을 정말 쉽지 않다. 게다가 내 프로젝트에 대해서 정리하여 남에게 설명하는 연습이 잘 되어있지 않아서 낯설고 힘들었지만 아직은 처음이니깐 앞으로 프로젝트를 하게된다면 오늘 배운 점을 고려하면서 작성하도록 노력할 것이다.