Skip to content

Commit

Permalink
Merge pull request #4 from skyway/clarify_credential_updates
Browse files Browse the repository at this point in the history
clarify credential renewal in README
  • Loading branch information
yusuke84 committed Mar 12, 2018
2 parents 307bddb + ee3fee0 commit 1b5259a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.jp.md
Expand Up @@ -14,7 +14,7 @@
4. (authToken、timestamp、ttlが含まれてる)credentialオブジェクトをクライアントに返信する
5. [例:JavaScriptとjQueryを利用したリクエスト](#例javascriptとjqueryを利用したリクエスト)のように `new Peer()`のオプション引数に認証サーバから取得したcredentialを渡してSkyWayのサーバに接続する

**※注意: new Peer() を実行する際は、毎回1〜5の手順を実施し、authTokenを更新して下さい** ネットワークの切断等で前のセッションがきれいに終了せず残っている場合、一定期間、同じPeerIdとauthTokenの組み合わせで再接続することが出来ません。authTokenを更新すればすぐに再接続が可能です。**
**※注意: new Peer() を実行する際は、毎回1〜5の手順を実施し、credentialを更新して下さい** ネットワークの切断等で前のセッションがきれいに終了せず残っている場合、一定期間、同じcredentialで再接続することが出来ません。credentialを更新すればすぐに再接続が可能です。

## クレデンシャルの形式

Expand Down
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -14,7 +14,7 @@ This repository contains samples that show how to calculate the credentials for
4. Send the credential object, (authToken, timestamp and token ttl,) back to the client
5. Connect to the SkyWay Server as normal using `new Peer()`, passing the credential as shown in [Example using JavaScript with jQuery](#example-using-javascript-with-jquery)

**Warning: Start again from step 1 and create a new authToken every time you call `new Peer()`.** If a client disconnected uncleanly due to network or other problems, the same peerId and authToken combination cannot be used for some time. It is possible to connect again immediately if a new authToken is used.
**Warning: Start again from step 1 and create a new credential object every time you call `new Peer()`.** If a client disconnected uncleanly due to network or other problems, the same credential cannot be used for some time. It is possible to connect again immediately if a new credential is used.

## Credential format

Expand Down

0 comments on commit 1b5259a

Please sign in to comment.