Skip to content

Commit 8a38c17

Browse files
authored
docs: add link to setup client id when use stable version (#318)
* docs: add link to setup client id when use stable version * fix link
1 parent 6dec7bc commit 8a38c17

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Introduction
66

7-
This is an out-of-the-box embeddable web application that help developers to integrate RingCentral services to their web applications with few codes.
7+
This is an out-of-the-box embeddable web application that help developers to integrate RingCentral services to their web applications with few code.
88

99
Built with:
1010

@@ -22,7 +22,7 @@ there are two ways to integrate this widget to a web application
2222

2323
#### Adapter JS way
2424

25-
Just add following codes to a website's header. It will create a RingCentral Embeddable widget in that web page.
25+
Just add following code to a website's header. It will create a RingCentral Embeddable widget in that web page.
2626

2727
```js
2828
<script>
@@ -37,20 +37,22 @@ Just add following codes to a website's header. It will create a RingCentral Emb
3737

3838
#### Iframe way
3939

40-
Create a iframe with the following codes:
40+
Create a iframe with the following code:
4141

4242
```html
4343
<iframe width="300" height="500" id="rc-widget" allow="microphone" src="https://ringcentral.github.io/ringcentral-embeddable/app.html">
4444
</iframe>
4545
```
4646

47-
You can use the config tool in this [page](https://ringcentral.github.io/ringcentral-embeddable) to generate codes with config.
47+
You can use the config tool in this [page](https://ringcentral.github.io/ringcentral-embeddable) to generate code with config.
4848

4949
#### Stable version
5050

51-
We provide latest RingCentral Embeddable version on github page `https://ringcentral.github.io/ringcentral-embeddable`. It includes latest features and bugfix in RingCentral Embeddable. And it will keep up to date with master codes. But we **recommend** developers to use versioned RingCentral Embeddable. Current latest stable version of RingCentral Embeddable is `1.0.1`. You can get versioned app in this uri `https://apps.ringcentral.com/integration/ringcentral-embeddable/1.0.1`.
51+
We provide latest RingCentral Embeddable version on github page `https://ringcentral.github.io/ringcentral-embeddable`. It includes latest features and bugfix in RingCentral Embeddable. And it will keep up to date with master code. But we **recommend** developers to use versioned RingCentral Embeddable. Current latest stable version of RingCentral Embeddable is `1.0.3`. You can get versioned app in this uri `https://apps.ringcentral.com/integration/ringcentral-embeddable/1.0.3`.
5252

53-
Just replace `https://ringcentral.github.io/ringcentral-embeddable` in upper codes to the versioned uri, and you will be using versioned RingCentral Embeddable. The versioned app will not be influenced when new features are added, so it will be more stable than latest version. When you need to update RingCentral Embeddable, you need to update the versioned app uri in your codes manually.
53+
Just replace `https://ringcentral.github.io/ringcentral-embeddable` in upper code to the versioned uri, and you will be using versioned RingCentral Embeddable. The versioned app will not be influenced when new features are added, so it will be more stable than latest version. When you need to update RingCentral Embeddable, you need to update the versioned app uri in your code manually.
54+
55+
For stable version from `1.0.2`, it is required to setup your own RingCentral client id. Please follow [here](docs/config-client-id-and-secret.md) to setup.
5456

5557
To get all versions of RingCentral Embeddable in [here](https://github.com/ringcentral/ringcentral-embeddable/releases).
5658

@@ -115,7 +117,7 @@ To get all versions of RingCentral Embeddable in [here](https://github.com/ringc
115117

116118
## Contribution and Development
117119

118-
We provide a online version that developers can use to embed and config in their web application. When you want to get a deep development of this widget, you can clone codes of this widget, update it and deploy by yourself.
120+
We provide a online version that developers can use to embed and config in their web application. When you want to get a deep development of this widget, you can clone code of this widget, update it and deploy by yourself.
119121

120122
### Clone the code
121123

@@ -173,7 +175,7 @@ If you create pull request to this repo and get merged, CI will deploy it to thi
173175

174176
1. Update `api.json` in production environment ([Graduate your RingCentral app to get production app client id](docs/config-client-id-and-secret.md#graduation-for-your-ringcentral-app))
175177

176-
2. Run command to compile codes and build release
178+
2. Run command to compile code and build release
177179

178180
```
179181
$ HOSTING_URL=your_host_uri yarn build

docs/get-started.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ there are two ways to integrate this widget to a web application:
44

55
## Adapter JS way
66

7-
Just add following the following codes to a website's header. It will create a iframe in your website.
7+
Just add following the following code to a website's header. It will create a iframe in your website.
88

99
```js
1010
<script>
@@ -19,7 +19,7 @@ Just add following the following codes to a website's header. It will create a i
1919

2020
## Iframe way
2121

22-
Create a iframe with the following codes:
22+
Create a iframe with the following code:
2323

2424
```html
2525
<iframe width="300" height="500" id="rc-widget" allow="microphone" src="https://ringcentral.github.io/ringcentral-embeddable/app.html">
@@ -28,9 +28,11 @@ Create a iframe with the following codes:
2828

2929
#### Stable version
3030

31-
We provide latest RingCentral Embeddable version on github page `https://ringcentral.github.io/ringcentral-embeddable`. It includes latest features and bugfix in RingCentral Embeddable. And it will keep up to date with master codes. But we **recommend** developers to use versioned RingCentral Embeddable. Current latest stable version of RingCentral Embeddable is `1.0.1`. You can get `1.0.1` app in this uri `https://apps.ringcentral.com/integration/ringcentral-embeddable/1.0.1`.
31+
We provide latest RingCentral Embeddable version on github page `https://ringcentral.github.io/ringcentral-embeddable`. It includes latest features and bugfix in RingCentral Embeddable. And it will keep up to date with master code. But we **recommend** developers to use versioned RingCentral Embeddable. Current latest stable version of RingCentral Embeddable is `1.0.1`. You can get `1.0.1` app in this uri `https://apps.ringcentral.com/integration/ringcentral-embeddable/1.0.1`.
3232

33-
Just replace `https://ringcentral.github.io/ringcentral-embeddable` in docs to the versioned uri, and you will be using versioned RingCentral Embeddable. The versioned app will not be influenced when new features are added, so it will be more stable than latest version. When you need to update RingCentral Embeddable, you need to update the versioned app uri in your codes manually.
33+
Just replace `https://ringcentral.github.io/ringcentral-embeddable` in docs to the versioned uri, and you will be using versioned RingCentral Embeddable. The versioned app will not be influenced when new features are added, so it will be more stable than latest version. When you need to update RingCentral Embeddable, you need to update the versioned app uri in your code manually.
34+
35+
For stable version from `1.0.2`, it is required to setup your own RingCentral client id. Please follow [here](config-client-id-and-secret.md) to setup.
3436

3537
To get all versions of RingCentral Embeddable in [here](https://github.com/ringcentral/ringcentral-embeddable/releases).
3638

0 commit comments

Comments
 (0)