webosose / ares-cli

ares-cli is a command-line interface(CLI) for webOS
Apache License 2.0
38 stars 17 forks source link

Update README file #100

Closed kclod-kim closed 8 months ago

kclod-kim commented 9 months ago

:Release Notes: Update README file

:Detailed Notes: Update information of @webosose/ares-cli

:Testing Performed:

  1. Checked CLI unit test
  2. Checked API unit test
  3. Checked README file

:Issues Addressed: [WRQ-9026] Update README.md

kclod-kim commented 9 months ago

code :+1: verify :+1:

ssuminahn commented 9 months ago

@Heeam-Shin 선임님, 해당 건 내용 리뷰 부탁드립니다.

Heeam-Shin commented 9 months ago

@ssuminahn 선임님,

이게 혹시 GitHub으로만 공개할 repository인가요? 그런 경우라면 제일 상단으로 내용을 올리고 아래와 같은 노트 스타일을 적용하는 편이 나아보입니다.

https://docs.github.com/ko/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

ssuminahn commented 9 months ago

@ssuminahn 선임님,

이게 혹시 GitHub으로만 공개할 repository인가요? 그런 경우라면 제일 상단으로 내용을 올리고 아래와 같은 노트 스타일을 적용하는 편이 나아보입니다.

https://docs.github.com/ko/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

important 정도이면 될까요? 어떤 레벨 생각하시나요? 현재로서 해당 문구 추가 반영은 github만 생각하고 있습니다.

Heeam-Shin commented 9 months ago

important보다는 warning 혹은 caution이 좀 더 의미가 맞을 것 같습니다. caution은 좀 센거 같아서 warning 추천합니다.

Heeam-Shin commented 9 months ago

노트 스타일 적용한다면 해당 내용들은(announce 내용 전부, 헤딩은 없이) summary 보다도 위로 배치하는 것이 적절해보입니다.

ssuminahn commented 9 months ago

@kclod-kim 책임님, 위 신선임님 코멘트 반영해서 한번 샘플 보면 좋을 것 같아요

kclod-kim commented 9 months ago

@ssuminahn 선임님, @Heeam-Shin 선임님.

warning 으롭 변경하였습니다. 줄바꿈은 전체적인 문서 스타일에 따라 적용하지 않았습니다.

kclod-kim commented 9 months ago

@ssuminahn 선임님, @Heeam-Shin 선임님. "we plan to develop and maintain a single webOS CLI to support multi webOS in @webos-sdk/cli." 로 추가 수정하였으니 확인 부탁드립니다.

kclod-kim commented 9 months ago

@ssuminahn 선임님 new line없이 위로 올리는 것으로 수정했습니다.