Skip to content

Commit 9f078a7

Browse files
authored
update README to add Get Started (#820)
* update README * update README
1 parent 4908241 commit 9f078a7

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,39 @@ RingCentral integration widgets aim to provide reusable RingCentral service modu
1212

1313
This project includes [RingCentral Integration Common Library](packages/ringcentral-integration/README.md) and [RingCentral Widgets Library](packages/ringcentral-widgets/README.md). The basic idea is to connect modules in RingCentral Integration Common Library with React components to provide ready to use UI widgets.
1414

15-
## Setup with development environment
15+
## Get Started
16+
17+
We use [RingCentral Widgets CLI](packages/ringcentral-widgets-cli/README.md) to startup a RingCentral Widgets based app.
18+
19+
```
20+
$ npm install -g ringcentral-widgets-cli
21+
$ rc-widgets -h
22+
```
23+
24+
### Create a new project
25+
26+
```
27+
rc-widgets new your_project_name
28+
cd your_project_name
29+
yarn install
30+
```
31+
32+
[Update `.env` file in project root path](packages/ringcentral-widgets-cli/README.md#start-developement-server).
33+
34+
### Start development server
35+
36+
```
37+
$ yarn start
38+
```
39+
Visit on [http://localhost:8080](http://localhost:8080) in browser.
40+
41+
For production build and deploy, please get more information in [here](packages/ringcentral-widgets-cli/README.md).
42+
43+
### Tutorials
44+
45+
This is a [demo](https://github.com/embbnux/ringcentral-widgets-demo) and [step-by-step tutorials](https://embbnux.github.io/ringcentral-widgets-demo/) show how to use this library.
46+
47+
## Contribution and Development
1648

1749
We use [Lerna.js](https://github.com/lerna/lerna) to manage packages source. And we require Node.js > 8.
1850

@@ -56,3 +88,8 @@ Open up your browser and access http://localhost:8080 to see how it works.
5688

5789
Note that the development server is using OAuth for authorization process.
5890
Please make sure the app you specified in configuration above is setup with Redirect Uri `http://localhost:8080/redirect.html`.
91+
92+
## Projects which use this library
93+
94+
- [RingCentral Embeddable Voice](https://github.com/ringcentral/ringcentral-embeddable-voice)
95+
- [RingCentral for Google Extension 4.0](https://chrome.google.com/webstore/detail/ringcentral-for-google/fddhonoimfhgiopglkiokmofecgdiedb)

0 commit comments

Comments
 (0)