docs: Updated README.md

README.md

@@ -1,70 +1,188 @@
 # KHeritageAPI
 
 KHeritageAPI is a Python wrapper designed to facilitate efficient and accurate access to Korea's rich cultural heritage
-data. It simplifies the process of querying and interpreting data
-from [Korea's Cultural Heritage API](https://www.cha.go.kr/html/HtmlPage.do?pg=/publicinfo/pbinfo3_0202.jsp&mn=NS_04_04_03),
-making it an
-invaluable tool for developers and researchers globally.
+data. It simplifies the process of querying and interpreting data from [Korea's Cultural Heritage API](https://www.cha.go.kr/html/HtmlPage.do?pg=/publicinfo/pbinfo3_0202.jsp&mn=NS_04_04_03).
 
-## Development Status
+KHeritageAPI는 문화재청이 제공하는 [한국 문화유산 API](https://www.cha.go.kr/html/HtmlPage.do?pg=/publicinfo/pbinfo3_0202.jsp&mn=NS_04_04_03)를
+위한 Python 래퍼입니다. 이 래퍼는 한국의 풍부한 문화유산 데이터에 효율적이고 정확하게 접근할 수 있도록 돕습니다.
 
-This project is currently **under active development**. While core functionalities are being implemented and tested, the
-package is not yet available on PyPI. Stay tuned for updates and the official release.
+## Development Status | 개발 상태 🛠️
 
-## Features
+This project is currently **under pre-release development**. The API is subject to change without notice, and compatibility with previous versions is not guaranteed.
 
-- Easy-to-use interface for accessing Korea's Cultural Heritage API.
-- Structured response handling for efficient data manipulation.
-- Comprehensive enumeration for types, provinces, and city codes.
-- Ongoing development and support for additional API functionalities.
+이 프로젝트는 현재 **프리 릴리즈 개발 중**입니다. API는 사전 예고 없이 변경될 수 있으며, 이전 버전과의 호환성은 보장되지 않습니다.
 
-## Installation
+## Installation | 설치 💿
+
+KHeritageAPI is available on PyPI. You can install it with pip:
+
+KHeritageAPI는 PyPI에 등록되어 있습니다. pip를 통해 설치할 수 있습니다:
 
 `pip install kheritage`
 
-## Usage
+## Features | 기능 🧰
+
+### Easy-to-use, intuitive interface | 사용하기 쉬운 직관적인 인터페이스 💡
+
+Instead of manually constructing the query URL with annigmatic parameters, you can simply create a `Search` object and
+use predefined enumerations that actually make sense. Also this will return a `SearchResult` object that contains
+all the information you need with a variable name that actually makes sense.
+
+알 수 없는 매개변수로 직접 쿼리 URL을 만드는 대신, `Search` 객체를 만들고 의미있는 미리 정의된 열거형을 사용할 수 있습니다.
+또한, 이는 의미있는 변수 이름으로 모든 정보를 담고 있는 `SearchResult` 객체를 반환하여 바로 사용할 수 있습니다.
+
+**Before | 이전 😭**
+```Python
+import requests
+
+base_url = "https://www.cha.go.kr/cha/SearchKindOpenapiList.do"
+paramter = {"stCcbaAsdt": 2020, "stCcbaAedt": 2020, "ccbaCtcd": 11, "ccbaKdcd": 11, "ccbaCndt": 1, "pageUnit": 15, "pageIndex": 1}
+response = requests.get(base_url, params=paramter)
+```
+
+**After | 이후 🤣**
+```Python
+from kheritageapi.api import Search
+from kheritageapi.models import CityCode, Seoul, HeritageType
+
+search = Search(result_count=15, city_code=CityCode.SEOUL, district_code=Seoul.JONGNRO, canceled=False,
+                heritage_type=HeritageType.HISTORIC_SITE)
+
+result = search.commit_search()
+```
+
+### Structured response handling | 구조화된 응답 처리 ✅
+You don't need to parse the response in XML. The response is already parsed and structured into a object like
+`SearchResult`, `ItemDetail`, `Event`, and more. This will boost your productivity via auto-completion and type hints
+provided by your IDE, eliminating the need to refer to the documentation every time you use the API.
+Also, all the objects has __str__ method, so you can print them directly in friendly format for debugging.
+
+더이상 XML로 응답을 파싱할 필요가 없습니다. 응답은 이미 파싱되어 `SearchResult`, `ItemDetail`, `Event` 등과 같은 객체로 구조화되어 있습니다.
+이는 IDE에서 제공하는 자동 완성과 타입 힌트를 통해 생산성을 높여주며, API를 사용할 때마다 문서를 참조할 필요가 없습니다.
+또한, 모든 객체는 __str__ 메소드를 가지고 있으므로, 디버깅을 위해 친숙한 형식으로 바로 출력할 수 있습니다.
+
+**Before | 이전 😭**
+```Python
+def parse_search_response(xml_response):
+    root = ET.fromstring(xml_response)
+    hits = root.find("totalCnt").text
+    limit = hits.find("pageUnit").text
+    offset = hits.find("pageIndex").text
+
+    ...
+
+    return SearchResult(hits, limit, offset, items ...)
+
+response = requests.get(base_url, params=paramter)
+hits, limit, offset, items ... = parse_search_response(response.text)
+
+print(hits)
+print(limit)
+print(offset)
+```
+
+```
+
+**After | 이후 🤣**
+```Python
+# Commit search alredy returns a SearchResult object ready to use!
+# 검색 결과는 이미 바로 사용할 수 있는 SearchResult 객체로 반환됩니다!
+result = search.commit_search() 
+
+print(result.hits)
+print(result.limit)
+print(result.offset)
+```
 
-Here's a basic example of how to use the KHeritageAPI to perform a search:
+### Comprehensive enumeration support | 포괄적인 열거형 지원 📋
+Enumerations provided eliminate the need to refer to the documentation every time you use the API, and
+eliminates the possibility of making a typo! Also, this will boost your productivity via auto-completion and type hints.
+
+이 패키지에서 제공하는 열거형은 API를 사용할 때마다 문서를 참조할 필요를 없애주며, 오타를 낼 가능성을 없애줍니다!
+또한, 이는 IDE에서 제공하는 자동 완성과 타입 힌트를 통해 생산성을 높여줍니다.
+
+**Before | 이전 😭**
+```Python
+# What is 11? What is 1? What is stCcbaAsdt? What is stCcbaAedt??? 😭
+# 11은 무엇인가요? 1은 무엇인가요? stCcbaAsdt는 무엇인가요? stCcbaAedt는 무엇인가요??? 😭
+
+paramter = {"stCcbaAsdt": 2020, "stCcbaAedt": 2020, "ccbaCtcd": 11, "ccbaKdcd": 11, "ccbaCndt": 1, "pageUnit": 15, "pageIndex": 1}
+```
+
+**After | 이후 🤣**
+```Python
+# Oh, we are querying for 2020, December, in Seoul's Jongno district, for 15 historic sites!
+# 아, 우리는 2020년 12월, 서울 종로구에 있는 15개의 역사적 유적을 검색하고 있군요!
+
+Search(result_count=15, city_code=CityCode.SEOUL, district_code=Seoul.JONGNRO, canceled=False,
+                heritage_type=HeritageType.HISTORIC_SITE)
+
+```
+
+## Example | 사용 예시 📃
+
+Search for 15 historic sites in Seoul's Jongno district, and search for detailed information on the first item, then print it.
+
+서울 종로구에 있는 15개의 역사적 유적을 검색하고, 첫 번째 항목에 대한 상세 정보를 검색하여 출력하기
 
 ```python
-from kheritageapi.api import Search, ItemDetail, EventSearch
+from kheritageapi.api import Search, ItemDetail
 from kheritageapi.models import CityCode, Seoul, HeritageType
 
 # Search for 15 historic sites in Seoul's Jongno district
+# 서울 종로구에 있는 15개의 역사적 유적을 검색하기
 search = Search(result_count=15, city_code=CityCode.SEOUL, district_code=Seoul.JONGNRO, canceled=False,
                 heritage_type=HeritageType.HISTORIC_SITE)
 result = search.commit_search()
 
 # Get detailed information on the first item
+# 첫 번째 항목에 대한 상세 정보 가져오기
 detail = ItemDetail(result.items[0])
 detail_info = detail.info()
 print(detail_info)
 
 # Also, you can get images and videos of the item
+# 또한, 항목의 이미지와 동영상을 가져올 수 있습니다
 images = detail.image()
 print(images)
 
 videos = detail.video()
 print(videos)
+```
+
+Search for events in December 2023, and print detailed information for the all the items.
+
+2023년 12월에 있는 행사를 검색하고, 검색 결과를 출력하기
+
+```python
+from kheritageapi.api import EventSearch
 
-# Search for events in 2023, December
 event_search = EventSearch(2023, 12)
 events = event_search.commit_search()
 for event in events:
     print(event)
 ```
 
-## Contributing
+
+## Contributing | 기여하기 🤝
 
 Contributions to KHeritageAPI are welcome. If you're interested in contributing, please fork the repository and submit a
-pull request with your changes.
+pull request with your changes! 🥰
+
+KHeritageAPI에 기여하는 것을 환영합니다. 기여하고 싶으시다면, 저장소를 포크하고 변경 사항을 반영한 풀 리퀘스트를 제출해주세요! 🥰
 
-## License
+## License | 라이선스 ⚖️
 
 This project is licensed under the [MIT License](LICENSE).
 
-## Acknowledgements
+이 프로젝트는 [MIT 라이선스](LICENSE)를 따릅니다.
+
+## Acknowledgements | 정보 ℹ️
 
 Developed with the enthusiasm of Jay Suh (jay@joseon.space) from the non-profit organization Joseon
 Space ([joseon.space](https://joseon.space)). This module aims to provide easy access to Korea's cultural heritage for
-developers and researchers around the world.
+developers and researchers around the world.
+
+비영리 단체 조선 스페이스([joseon.space](https://joseon.space))의 서재웅 (jay@joseon.space)의 열정으로 개발된 프로젝트 입니다.
+이 모듈은 전 세계의 개발자와 연구자들이 한국의 문화유산에 쉽게 접근할 수 있도록 목표로 합니다.
+

kheritageapi/__init__.py

@@ -1,3 +1,3 @@
-__version__ = '0.0.5'
+__version__ = '0.1.0'
 
 from kheritageapi import *

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "kheritage"
-version = "0.0.5"
+version = "0.1.0"
 authors = [
   { name="Jay Suh", email="jay@joseon.space" },
 ]