Skip to content

Commit 76e2690

Browse files
committed
docs: README.md 업데이트 (#7)
1 parent b0ea69f commit 76e2690

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,18 @@
11
# sangmyung-univ-auth ![Python versions](https://img.shields.io/badge/Python-3.9-blue) ![License](https://img.shields.io/badge/license-MIT-green) ![Release](https://img.shields.io/badge/release-0.0.1-red)
2-
### 상명대학교 재학생 인증 라이브러리
2+
상명대학교 재학생 인증 라이브러리
33

4-
---
4+
## Features
5+
- 상명대학교 재학생 여부를 간편하게 확인하는 라이브러리입니다.
6+
- 재학생 인증 방식은 상명대학교 e-Campus 세션 인증 방식입니다.
57

68
## Easy to install
7-
89
**Pip**: `pip install sangmyung-univ-auth`
910

1011
**Direct:**
11-
1212
- `git clone https://github.com/hyunmin0317/sangmyung-univ-auth`
1313
- `python setup.py install`
1414

1515
## Easy to use
16-
17-
상명대학교 재학생 여부를 간편하게 확인하는 라이브러리입니다.<br>
18-
재학생 인증 방식은 상명대학교 e-Campus 세션 인증 방식이며,<br>
19-
해당 라이브러리 사용 방법은 아래와 같습니다.
20-
2116
```python
2217
>>> from sangmyung_univ_auth import auth
2318
>>> result = auth('201911019', '<my-password>')
@@ -31,10 +26,7 @@ True
3126
{'name': '최현민', 'department': '컴퓨터과학전공', 'email': '[email protected]'}
3227
```
3328

34-
### AuthResponse
35-
36-
인증 결과는 namedtuple 형태로 반환됩니다.
37-
29+
## AuthResponse
3830
```python
3931
AuthResponse(
4032
is_auth=True,
@@ -46,6 +38,7 @@ AuthResponse(
4638
}
4739
)
4840
```
41+
4942
- **is_auth: 인증 성공 여부**
5043
- Type: bool
5144
- Value
@@ -63,3 +56,6 @@ AuthResponse(
6356
- name: 이름
6457
- department: 학과
6558
- email: 이메일
59+
60+
## References
61+
- https://pypi.org/project/sangmyung-univ-auth/

0 commit comments

Comments
 (0)