-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from ifad/chore/improve-readme
Improve Readme
- Loading branch information
Showing
1 changed file
with
19 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,7 +8,9 @@ Sharepoint 2013 REST API client. Work in progress, not for the faint hearted. | |
|
||
Add this line to your application's Gemfile: | ||
|
||
gem 'sharepoint', git: '[email protected]:ifad/sharepoint' | ||
```rb | ||
gem 'sharepoint', git: 'https://github.com/ifad/sharepoint.git' | ||
``` | ||
|
||
And then execute: | ||
|
||
|
@@ -20,20 +22,28 @@ And then execute: | |
|
||
You can instantiate a number of SharePoint clients in your application: | ||
|
||
client = Sharepoint::Client.new({ | ||
username: "username", | ||
password: "password", | ||
uri: "http://sharepoint_url" | ||
}) | ||
```rb | ||
client = Sharepoint::Client.new({ | ||
username: 'username', | ||
password: 'password', | ||
uri: 'https://sharepoint_url' | ||
}) | ||
``` | ||
|
||
### Get documents of a folder | ||
|
||
client.documents_for path | ||
```rb | ||
client.documents_for path | ||
``` | ||
|
||
### Upload a document | ||
|
||
client.upload filename, content, path | ||
```rb | ||
client.upload filename, content, path | ||
``` | ||
|
||
### Update document metadata | ||
|
||
client.update_metadata filename, metadata, path | ||
```rb | ||
client.update_metadata filename, metadata, path | ||
``` |