Skip to content

Commit

Permalink
Merge pull request #9 from KMConner/update-readme
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
KMConner authored May 27, 2020
2 parents 30df8b5 + db8e8eb commit 8a81873
Showing 1 changed file with 5 additions and 16 deletions.
21 changes: 5 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,13 @@ KULASIS にアクセスするためアプリケーション・ライブラリ

## 含まれているアプリケーション

- `token_getter` アクセストークンを取得するためのプログラム
- `kulasis_client` KULASIS にある情報を取得するためのプログラム
- `kulasis_client` KULASIS にある情報を取得するためのプログラム (Release からダウンロード可能)
- `mail_notifier` 講義の連絡メールを通知するプログラム (開発中)

## 認証に関して

アクセスする前には `kulasisi_client login` コマンドを使うことで自動的に認証情報が取得され、 Windows の場合には資格情報マネージャー、 macOS の場合にはキーチェーンに保存される。

## ライブラリの機能

### 実装済み
Expand All @@ -22,20 +25,6 @@ KULASIS にアクセスするためアプリケーション・ライブラリ
- 休講、補講に関する情報取得
- 授業変更情報の取得

## 認証に関して

アクセスの際には以下の 2 つの値が必要

- Account no
- Access token

これらの値は `token_getter` を使って取得できる。
以下のコマンドを実行し、 ECS ID とパスワードを入力して取得できる。

```bash
go run cmd/token_getter/main.go
```

## その他

- バグ報告、改善提案、大歓迎です。プルリクももちろん大歓迎。 (英語、日本語どちらでも)
Expand Down

0 comments on commit 8a81873

Please sign in to comment.