Skip to content

Commit

Permalink
Improve Readme
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
tagliala committed Feb 8, 2024
1 parent dde5ef0 commit 5988a77
Showing 1 changed file with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
```

0 comments on commit 5988a77

Please sign in to comment.