Merge pull request #25 from kimsehwan96/master

release v1.0.0.2

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

README.md

@@ -1,13 +1,26 @@
 # Pyjosa
 
-- 입력받은 한글 문자에 종성이 있을경우, 없을 경우를 구분하여 `을/를`, `이/가`와 같은 조사를 자동으로 붙여주는 패키지
+![PyPI](https://img.shields.io/pypi/v/pyjosa?style=plastic)  ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyjosa)
+![GitHub](https://img.shields.io/github/license/kimsehwan96/pyjosa) ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/kimsehwan96/pyjosa/Publish%20Python%20%F0%9F%90%8D%20distributions%20%F0%9F%93%A6%20to%20PyPI/release) 
 
-- `PyPI`를 통해 배포 할 예정.
+![PyPI - Downloads](https://img.shields.io/pypi/dm/pyjosa) 
+
+입력받은 한글 문자에 종성이 있을경우, 없을 경우를 구분하여 `을/를`, `이/가`와 같은 조사를 자동으로 붙여주는 패키지
+
+`PyPI`에 배포 하였음. 현재 버전 ![PyPI](https://img.shields.io/pypi/v/pyjosa?style=plastic)
+
+## 공식 도큐먼트
+
+https://kimsehwan96.github.io/pyjosa/
 
 ## 설치
 
 `python3 -m pip install pyjosa`
 
+혹은
+
+`pip install pyjosa`
+
 ## 사용법
 
 ```python3
@@ -31,15 +44,13 @@ print(Josa.get_full_string("물", "나")) # 물이나
 
 ## Core Concept
 
-- 추후 작성 예정
 
-## release
+## Release
 
-- 추후 작성 예정
 
 ## Contribute
 
-- 추후 작성 예정
+
 
 
 

docs/1_INSTALL/README.md

@@ -0,0 +1,3 @@
+# 설치 방법
+
+설치 방법에 대해서 소개합니다.

docs/1_INSTALL/install.md

@@ -0,0 +1,13 @@
+# pip install
+
+1. pip를 이용하여 설치하는 방법 (pip command)
+
+```console
+pip install pyjosa
+```
+
+2. pip를 이용하여 설치하는 방법 (python3 command)
+
+```console
+python3 -m pip install pyjosa
+```

docs/2_EXAMPLE/README.md

@@ -0,0 +1,3 @@
+# 사용 예시
+
+사용 예시에 대해 소개합니다.

docs/2_EXAMPLE/example1.md

@@ -0,0 +1,19 @@
+# 간단한 사용 방법
+
+```python
+from pyjosa.josa import Josa
+
+print(Josa.get_josa("철수", "은")) # 는
+print(Josa.get_josa("오리", "을")) # 를
+print(Josa.get_josa("닭", "는")) # 은
+print(Josa.get_josa("산", "으로")) # 으로
+print(Josa.get_josa("명예", "과")) # 와
+print(Josa.get_josa("물", "나")) # 이나
+
+print(Josa.get_full_string("철수", "은")) # 철수는
+print(Josa.get_full_string("오리", "을")) # 오리를
+print(Josa.get_full_string("닭", "는")) # 닭은
+print(Josa.get_full_string("산", "으로")) # 산으로
+print(Josa.get_full_string("명예", "과")) # 명예와
+print(Josa.get_full_string("물", "나")) # 물이나
+```

docs/2_EXAMPLE/example2.md

@@ -0,0 +1,23 @@
+# 유용한 사용 방법
+
+```python
+from pyjosa.josa import Josa
+
+subject = '철수'
+obj = '산'
+
+full_string = f'{Josa.get_full_string(subject, '은')} {Josa.get_full_string(obj, '를')} 간다'
+
+print(full_string) # 철수는 산을 오른다
+```
+
+```python
+from pyjosa.josa import Josa
+
+subjects = ['철수', '세환', '길동']
+obj = ['산', '바다', '집']
+
+for i, v in enumerate(subjects):
+    print(f'{Josa.get_full_string(v, '은')} {Josa.get_full_string(obj[i], '를')} 간다')
+
+```

docs/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "jekyll-rtd-theme", "~> 2.0.6"
+
+gem "github-pages", group: :jekyll_plugins