기능

ReadMe.io와 연동하여 개발자들이 API 문서를 효율적으로 관리하고 동기화할 수 있도록 도와주는 ReadMe.io의 공식 CLI 도구이다.

rdme를 통해 새로운 코드를 배포할 때마다 ReadMe의 가이드나 API 참조를 자동으로 업데이트하는 github action을 만들 수 있다.

설치

node.js부터 설치해야 한다. 참고: https://nodejs.org/en/download

확인: node.js와 npm이 둘다 설치되어 있어야 한다.

node -v
npm -v

1. 글로벌 설치 (권장 - 개인 사용)

npm install -g rdme

2. 프로젝트별 설치 (권장 - 팀 프로젝트)

*# 개발 의존성으로 설치*
npm install rdme --save-dev

*# 사용 시 npx 사용*
npx rdme --version

확인

rdme --version

3. autocomplete

아래 명령어 실행시 auto completion 적용 방법이 터미널에 뜬다. 그대로 따라하면 됨

rdme autocomplete