diff --git a/README-ko.md b/README-ko.md index 04aa681..5bb5e8c 100644 --- a/README-ko.md +++ b/README-ko.md @@ -20,6 +20,23 @@ brew install droller brew remove droller ``` +## Options + +| option | description | example | +|-----------|----------------------------------------|-------------------| +| | uri를 인덱스에 추가합니다. | droller http://.. | +| random, | 랜덤으로 문서를 선택합니다. | droller | +| open, o | 선택된 문서를 웹 브라우저로 봅니다. | droller o | +| +1, 1 | 선택된 문서에 +1 점을 줍니다. | droller 1 | +| -1, - | 선택된 문서에 -1 점을 줍니다. | droller - | +| delete, d | 선택된 문서를 삭제합니다. | droller d | +| status, s | 선택된 문서 정보를 봅니다. | droller s | +| ranking | 모든 문서의 점수 랭킹을 봅니다. | droller ranking | +| backup, b | git을 사용해 인덱스 파일을 백업합니다. | droller b | +| log, l | 백업 로그를 봅니다. | droller l | +| edit, e | 인덱스 파일을 편집합니다. | droller e | +| help, h | 도움말을 봅니다. | droller h | + ## How to use Twitter나 Facebook에 누군가 괜찮아보이는 링크를 올리면 복사해서 터미널에 다음과 같이 입력합니다. @@ -77,3 +94,4 @@ droller help ```sh droller edit ``` + diff --git a/README.md b/README.md index e8d980a..fd32227 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,23 @@ brew install droller brew remove droller ``` +## Options + +| option | description | example | +|-----------|--------------------------------------|-------------------| +| | Add a record to index file. | droller http://.. | +| random, | Select randomly. | droller | +| open, o | Open the selected record. | droller o | +| +1, 1 | +1 to the selected record. | droller 1 | +| -1, - | -1 to the selected record. | droller - | +| delete, d | Delete a record from the index file. | droller d | +| status, s | Show the selected record. | droller s | +| ranking | Show the ranking table. | droller ranking | +| backup, b | Back up your index file using git. | droller b | +| log, l | Show backup logs. | droller l | +| edit, e | Edit the index file. | droller e | +| help, h | Help. | droller h | + ## How to use If someone posts a link that looks good on Twitter or Facebook, copy it. Then type the following command in the terminal. diff --git a/bin/droller b/bin/droller index 538d02e..b94023d 100755 --- a/bin/droller +++ b/bin/droller @@ -5,17 +5,17 @@ INDEX="$DIRECTORY/index" HEAD="$DIRECTORY/head" ## usage: droller [s | o | 1 | -1 | ranking | edit | | | d | h] -## [status | s] # Show the selected record # Example: droller s +## [] # Add a record to index file # Example: droller http://www... +## [random | ] # Select randomly # Example: droller ## [open | o] # Open the selected record # Example: droller o ## [+1 | 1] # +1 to the selected record # Example: droller 1 ## [-1 | -] # -1 to the selected record # Example: droller -1 +## [delete | d] # Delete a record from the index file # Example: droller d +## [status | s] # Show the selected record # Example: droller s ## [ranking] # Show the ranking table # Example: droller ranking -## [random | ] # Show the ranking table # Example: droller +## [backup | b] # Back up your index file # Example: droller backup +## [log | l] # Show backup logs # Example: droller l ## [edit | e] # Edit the index file # Example: droller edit -## [] # Add a record to the index file # Example: droller http://www... -## [delete | d] # Delete a record from the index file # Example: droller d -## [backup | b] # Back up your index file. # Example: droller backup -## [log | l] # Show backup logs. # Example: droller l ## [help | h] # Help # Example: droller h main() {