README.md in groupdocs-0.3.11 vs README.md in groupdocs-1.0.0
- old
+ new
@@ -34,12 +34,12 @@
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'
- groupdocs.api_version = '2.0'
+ 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">
```
@@ -47,15 +47,16 @@
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">
-
-GroupDocs::Document.find!(:name, 'CV.doc', client_id: 'your_client_id', private_key: 'your_private_key')
-#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="Folder1", @url="http://groupdocs.com">
```
+### Documentation
+
+Reference to [this page](http://rubydoc.info/gems/groupdocs) for docs
+
### Entities
All entities can be initialized in several ways.
* Object is created, attributes are set later.
@@ -80,62 +81,9 @@
GroupDocs::Storage::Folder.new do |folder|
folder.name = 'Folder'
end
#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @name="Folder">
```
-
-### Find entities
-
-Some entities support `#all!`, `#find!` and `#find_all!` methods. You can pass any attribute that object responds to and its value to find with.
-
-* List all files
-
-```ruby
-GroupDocs::Storage::File.all!
-#=> [#<GroupDocs::Storage::File:0x0000000171f432 @id=123, @guid="uhfsa9dry29rhfodn", @name="resume.pdf", @url="http://groupdocs.com">, #<GroupDocs::Storage::File:0x0000000171f498 @id=456, @guid="soif97sr9u24bfosd9", @name="CV.doc", @url="http://groupdocs.com">]
-```
-
-* Find folder with name `Folder1`
-
-```ruby
-GroupDocs::Storage::Folder.find!(:name, 'Folder1')
-#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="Folder1", @url="http://groupdocs.com">
-```
-
-* Find all folders which name starts with `Folder`
-
-```ruby
-GroupDocs::Storage::Folder.find_all!(:name, /^Folder/)
-#=> [#<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="Folder1", @url="http://groupdocs.com">, #<GroupDocs::Storage::Folder:0x0000000171f467 @id=2, @name="Folder2", @url="http://groupdocs.com">]
-```
-
-### Annotation API
-
-Read more about examples of using Annotation API on [wiki](https://github.com/p0deje/groupdocs-ruby/wiki/Annotation-API).
-
-### Assembly API
-
-Read more about examples of using Assembly API on [wiki](https://github.com/p0deje/groupdocs-ruby/wiki/Assembly-API).
-
-### Comparison API
-
-Read more about examples of using Comparison API on [wiki](https://github.com/p0deje/groupdocs-ruby/wiki/Comparison-API).
-
-### Document API
-
-Read more about examples of using Document API on [wiki](https://github.com/p0deje/groupdocs-ruby/wiki/Document-API).
-
-### Job API
-
-Read more about examples of using Job API on [wiki](https://github.com/p0deje/groupdocs-ruby/wiki/Job-API).
-
-### Signature API
-
-Not yet implemented.
-
-### Storage API
-
-Read more about examples of using Storage API on [wiki](https://github.com/p0deje/groupdocs-ruby/wiki/Storage-API).
### Copyright
Copyright (c) 2012 Aspose Inc.