README.md in groupdocs-2.2.0 vs README.md in groupdocs-2.3.0

- old
+ new

@@ -1,94 +1,94 @@ -## GroupDocs - -Ruby SDK for [GroupDocs](http://groupdocs.com) REST API. - -## Installation - -Install as usually - - gem install groupdocs - -Installing from source - - gem install bundler # unless it's already installed - git clone git@github.com:groupdocs/groupdocs-ruby.git - cd groupdocs-ruby/ - git checkout master - bundle install --path vendor/bundle - bundle exec rake install - -## Usage - -All "bang" methods (ending with exclamation sign) imply interaction with API server. - -Other methods (with expect to some, see documentation) do not operate with API Server - -### Configuration - -First of all you need to configure your access to API server. - -```ruby -require 'groupdocs' - -GroupDocs.configure do |groupdocs| - groupdocs.client_id = 'your_client_id' - groupdocs.private_key = 'your_private_key' - # optionally specify API server and version - groupdocs.api_server = 'https://dev-api.groupdocs.com' # default is 'https://api.groupdocs.com' - groupdocs.api_version = '3.0' # default is '2.0' -end - -GroupDocs::Storage::Folder.create!('/folder') -#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="folder", @url="http://groupdocs.com"> -``` - -You can also pass access credentials to particular requests - -```ruby -GroupDocs::Storage::Folder.create!('/folder', client_id: 'your_client_id', private_key: 'your_private_key') -#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="folder", @url="http://groupdocs.com"> -``` - -### Documentation - -Reference to [this page](http://rubydoc.info/gems/groupdocs) for docs and examples. - -There is rather exhaustive documentation about internal SDK structure at [wiki page](https://github.com/groupdocs/groupdocs-ruby/wiki/Documentation-&-Guide). - -There are also some examples in [repository](https://github.com/groupdocs/groupdocs-ruby/tree/master/examples) and on [wiki](https://github.com/groupdocs/groupdocs-ruby/wiki) - -### Entities - -All entities can be initialized in several ways. - -* Object is created, attributes are set later. - -```ruby -folder = GroupDocs::Storage::Folder.new -folder.name = 'Folder' -folder.inspect -#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @name="Folder"> -``` - -* Hash of attributes are passed to object constructor. - -```ruby -GroupDocs::Storage::Folder.new(name: 'Folder') -#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @name="Folder"> -``` - -* Block is passed to object constructor. - -```ruby -GroupDocs::Storage::Folder.new do |folder| - folder.name = 'Folder' -end -#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @name="Folder"> -``` -## License - -GroupDocs Ruby SDK is released under the [MIT License](https://github.com/groupdocs/groupdocs-ruby/blob/master/LICENSE.txt). - -### Copyright - -Copyright (c) 2012 Aspose Inc. +## GroupDocs + +Ruby SDK for [GroupDocs](http://groupdocs.com) REST API. + +## Installation + +Install as usually + + gem install groupdocs + +Installing from source + + gem install bundler # unless it's already installed + git clone git@github.com:groupdocs/groupdocs-ruby.git + cd groupdocs-ruby/ + git checkout master + bundle install --path vendor/bundle + bundle exec rake install + +## Usage + +All "bang" methods (ending with exclamation sign) imply interaction with API server. + +Other methods (with expect to some, see documentation) do not operate with API Server + +### Configuration + +First of all you need to configure your access to API server. + +```ruby +require 'groupdocs' + +GroupDocs.configure do |groupdocs| + groupdocs.client_id = 'your_client_id' + groupdocs.private_key = 'your_private_key' + # optionally specify API server and version + groupdocs.api_server = 'https://dev-api.groupdocs.com' # default is 'https://api.groupdocs.com' + groupdocs.api_version = '3.0' # default is '2.0' +end + +GroupDocs::Storage::Folder.create!('/folder') +#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="folder", @url="http://groupdocs.com"> +``` + +You can also pass access credentials to particular requests + +```ruby +GroupDocs::Storage::Folder.create!('/folder', client_id: 'your_client_id', private_key: 'your_private_key') +#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="folder", @url="http://groupdocs.com"> +``` + +### Documentation + +Reference to [this page](http://rubydoc.info/gems/groupdocs) for docs and examples. + +There is rather exhaustive documentation about internal SDK structure at [wiki page](https://github.com/groupdocs/groupdocs-ruby/wiki/Documentation-&-Guide). + +There are also some examples in [repository](https://github.com/groupdocs/groupdocs-ruby/tree/master/examples) and on [wiki](https://github.com/groupdocs/groupdocs-ruby/wiki) + +### Entities + +All entities can be initialized in several ways. + +* Object is created, attributes are set later. + +```ruby +folder = GroupDocs::Storage::Folder.new +folder.name = 'Folder' +folder.inspect +#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @name="Folder"> +``` + +* Hash of attributes are passed to object constructor. + +```ruby +GroupDocs::Storage::Folder.new(name: 'Folder') +#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @name="Folder"> +``` + +* Block is passed to object constructor. + +```ruby +GroupDocs::Storage::Folder.new do |folder| + folder.name = 'Folder' +end +#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @name="Folder"> +``` +## License + +GroupDocs Ruby SDK is released under the [MIT License](https://github.com/groupdocs/groupdocs-ruby/blob/master/LICENSE.txt). + +### Copyright + +Copyright (c) 2012 Aspose Inc.