Skip to content

Commit dec12b2

Browse files
committed
docs: README.md: update
1 parent 45c2873 commit dec12b2

File tree

2 files changed

+27
-17
lines changed

2 files changed

+27
-17
lines changed

README.md

+18-17
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,6 @@ RingCentral SDK for Ruby
3737

3838
A Ruby SDK for the [RingCentral REST API](https://developers.ringcentral.com).
3939

40-
## Important Notes
41-
42-
Version 2.0.0 introduces the following backward breaking changes:
43-
44-
* SDK instantiation by moving to a block-based configuration
45-
* Removal of `RingCentralSdk::REST::Config` class
46-
* Removal of `RingCentralSdk::REST::Client.authorize_user` method
47-
4840
## Documentation
4941

5042
Full documentation and resources are available at:
@@ -88,12 +80,7 @@ client = RingCentralSdk::REST::Client.new do |config|
8880
config.client_secret = 'myAppClientSecret'
8981
config.server_url = RingCentralSdk::RC_SERVER_SANDBOX
9082

91-
# User info for password grant (optional)
92-
config.username = 'myUsername'
93-
config.extension = 'myExtension'
94-
config.password = 'myPassword'
95-
96-
# JWT (optional)
83+
# JWT Bearer Grant (optional)
9784
config.jwt = 'myJwt'
9885

9986
# Set a custom logger (optional)
@@ -248,11 +235,25 @@ RingCentral Official SDKs
248235
4. Push to the branch (`git push origin my-new-feature`)
249236
5. Create new Pull Request
250237

238+
### Development
239+
240+
To build local development copy of the gem use:
241+
242+
```
243+
% gem build ringcentral_sdk.gemspec
244+
```
245+
246+
This will produce a file like: `ringcentral_sdk-3.1.0.gem` which you can install with:
247+
248+
```
249+
% gem install ringcentral_sdk-3.1.0.gem
250+
```
251+
251252
## License
252253

253-
RingCentral SDK is available under an MIT-style license. See [LICENSE.md](LICENSE.md) for details.
254+
RingCentral SDK is available under an MIT-style license. See [LICENSE](LICENSE) for details.
254255

255-
RingCentral SDK © 2015-2023 by John Wang
256+
RingCentral SDK © 2015-2024 by John Wang
256257

257258
[gem-version-svg]: https://badge.fury.io/rb/ringcentral_sdk.svg
258259
[gem-version-url]: http://badge.fury.io/rb/ringcentral_sdk
@@ -277,7 +278,7 @@ RingCentral SDK © 2015-2023 by John Wang
277278
[docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg
278279
[docs-rubydoc-url]: http://www.rubydoc.info/gems/ringcentral_sdk/
279280
[license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
280-
[license-url]: https://github.com/grokify/ringcentral-sdk-ruby/blob/master/LICENSE.md
281+
[license-url]: https://github.com/grokify/ringcentral-sdk-ruby/blob/master/LICENSE
281282
[chat-svg]: https://img.shields.io/badge/chat-on%20glip-orange.svg
282283
[chat-url]: https://glipped.herokuapp.com/
283284
[stackoverflow-svg]: https://img.shields.io/badge/Stack%20Overflow-ringcentral-orange.svg

scripts/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@ To contribute to community adoption of the RingCentral Ruby SDK, please add
1111
your scripts and programs to this folder. Include a brief comment at
1212
the beginning of your source describing what it does.
1313

14+
## Installation
15+
16+
### Install Dependencies
17+
18+
```
19+
% gem install bundler
20+
% bundle install
21+
```
22+
1423
## Credentials
1524

1625
Many of the scripts in this folder use a `.env` file to hold application and

0 commit comments

Comments
 (0)