Implement KMI-0003 index set

documents/KMI/KMI-0003.md

@@ -1,2 +1,50 @@
 # KMI-0003
 
+## How to
+
+PER 의 적정값에 해당되는 종목을 선별합니다.
+
+**한국투자증권**에서 우선적으로 제공되는 PER 를 사용합니다.
+
+차후에는 PER 값을 예측하도록 개선될 예정입니다.
+
+적합한 PER 를 선별하는 기준은 다음과 같습니다.
+
+* PER 10.0 이하에 대해서는 (10 - PER) * 5 점수를 부여합니다.
+* PER 20.0 이하에 대해서는 (20 - PER) * 4 점수를 부여합니다.
+* PER 20.0 초과의 종목은 선별되지 않습니다.
+
+
+## Usage
+
+다음은 지표 데이터(index set)를 추출하는 방법입니다.
+
+```bash
+./KissMeIndex KMI-0003 20230621 100000 config.json
+{
+  "code": 200,
+  "message": "OK",
+  "kmi": "KMI-0003",
+  "output": [
+    {
+      "weight": 0.054464283149246694,
+      "shortCode": "251370",
+      "productName": "와이엠티"
+    },
+    {
+      "weight": 0.053163216418169394,
+      "shortCode": "112610",
+      "productName": "씨에스윈드"
+    },
+    {
+      "weight": 0.050551000379436384,
+      "shortCode": "000520",
+      "productName": "삼일제약"
+    },
+...
+```
+
+
+## Configuration
+
+현재 여기에는 환경설정 정보가 없습니다.

documents/KMI/KMI-0005.md

@@ -41,7 +41,7 @@
 
 ### INPUT
 * (indexApp) KMI-(number) (date) (time) (config.json)
-  * (indexApp) 는 지표를 추출하는 앱입니다. INPUT, OUTPUT 형식만 맞출 수 있다면, 다양한 도구를 통해서 만들 수 있습니다.
+  * (indexApp) 는 지표를 추출하는 app binary 입니다. INPUT, OUTPUT 형식만 맞출 수 있다면, 다양한 도구를 통해서 만들 수 있습니다.
   * KMI-(number) 는 고유의 지표 번호입니다. 하나의 app 에서 여러 지표를 추출할 수 있습니다.
   * (date) 는 yyyyMMdd 형식의 날짜입니다.
   * (time) 는 HHmmss 형식의 시간입니다.
@@ -51,12 +51,13 @@
 
 json 파일 형식으로 결과를 제공합니다.
 
-* code: 에러코드를 의미합니다. `200` 은 성공.
-* message: 상세한 메시지를 의미합니다. 성공하면 `OK`.
-* kmi: 요청에 제공되는 KMI 지표를 의미합니다.
-* output: 지표 데이터입니다.
-  * shortCode : 추천종목 코드 번호입니다.
-  * weight : [-1.0, 1.0] 사이의 가중치 값입니다. 음수이면 매도 성향이고, 양수이면 매수성향입니다.
+* `code`: 에러코드. `200` 은 성공.
+* `message`: 상세한 메시지. 성공하면 `OK`.
+* `kmi`: 요청에 제공되는 KMI 지표
+* `output`: 지표 데이터
+  * `shortCode` : 추천종목 코드 번호
+  * `productName` : 종목명
+  * `weight` : [-1.0, 1.0] 사이의 가중치 값. 음수이면 매도 성향이고, 양수이면 매수성향.
 
 ### Configuration