Skip to content

Commit fc8b378

Browse files
authored
Readme updates (#46)
* Update README.md * Added types-demo.PNG * Add files via upload * Update README.md * Add files via upload * Add files via upload * Add files via upload * Add files via upload * Update README.md * Removed dead link * Update README.md * Update README.md * Update README.md
1 parent 2719513 commit fc8b378

File tree

2 files changed

+32
-30
lines changed

2 files changed

+32
-30
lines changed

README.md

+32-30
Original file line numberDiff line numberDiff line change
@@ -2,45 +2,26 @@
22
[![npm version badge](https://img.shields.io/npm/v/@microsoft/microsoft-graph-client.svg?maxAge=86400)](https://www.npmjs.com/package/@microsoft/microsoft-graph-client)
33
[![Travis](https://travis-ci.org/microsoftgraph/msgraph-sdk-javascript.svg?branch=master&style=flat-square)](https://travis-ci.org/microsoftgraph/msgraph-sdk-javascript)
44

5-
The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API that supports both Node and the browser. See the [samples](samples) folder for code examples. You can also use our [TypeScript graph types](https://github.com/microsoftgraph/msgraph-typescript-typings) with this library. We love your feedback! You can file an issue in this repository or write on our [UserVoice page](https://officespdev.uservoice.com/).
5+
The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API that can be used server-side and in the browser. See the [samples](samples) folder for code examples. You can also use our [TypeScript graph types](https://github.com/microsoftgraph/msgraph-typescript-typings) with this library. We love your feedback! You can file an issue in this repository or write on our [UserVoice page](https://officespdev.uservoice.com/).
6+
7+
**Looking for IntelliSense on models (Users, Groups, etc.)? Check out the [Microsoft Graph Types](https://github.com/microsoftgraph/msgraph-typescript-typings) repository!**
8+
9+
[![TypeScript demo](https://raw.githubusercontent.com/microsoftgraph/msgraph-sdk-javascript/readme-updates/types-demo.PNG)](https://github.com/microsoftgraph/msgraph-typescript-typings)
610

711
## Installation
812
### Node
9-
You can find installation instructions at the [Node.js website](https://nodejs.org/).
13+
1) Install [Node.js and npm](https://nodejs.org/).
1014

11-
```npm install @microsoft/microsoft-graph-client```
15+
2) ```npm install @microsoft/microsoft-graph-client```
1216

13-
Include the library in your JavaScript file with `const MicrosoftGraph = require("@microsoft/microsoft-graph-client");`
17+
3) Include the library in your JavaScript file with `const MicrosoftGraph = require("@microsoft/microsoft-graph-client");`
1418

1519
### Browser
1620

1721
Include [lib/graph-js-sdk-web.js](https://github.com/microsoftgraph/msgraph-sdk-javascript/raw/master/lib/graph-js-sdk-web.js) in your page.
1822
```html
1923
<script type="text/javascript" src="graph-js-sdk-web.js"></script>
2024
```
21-
## Changelog
22-
23-
#### 1.0.0
24-
* Added tests for new Graph functionality - Delta query, Extensibility, OneNote, and more.
25-
26-
#### 0.4.0
27-
* Add support for ES5. Make sure to use `graph-js-sdk-web.js` for web apps
28-
* Removed iterator helper method.
29-
30-
#### 0.3.1
31-
* Support for Node.js versions 4 and 5
32-
33-
#### 0.3.0
34-
* Migrated away from typings in client library core and TypeScript sample
35-
36-
#### 0.2.2
37-
* Updated SuperAgent to version ``` 3.3.0 ```
38-
39-
#### 0.2.0
40-
* **Breaking change for existing apps** - Initialize the client library with `MicrosoftGraph.Client.init({...})`. See the updated usage section below for code samples.
41-
* Added response handling tests to simulate Graph calls
42-
* Added type declarations file for core client library, which adds intellisense for chained methods.
43-
4425

4526
## Usage
4627
### Initialize client with access token provider
@@ -65,8 +46,6 @@ All calls to Microsoft Graph are chained together starting with `client.api(path
6546
* https://graph.microsoft.com/beta/me
6647
* me/events?$filter=startswith(subject, 'ship')
6748

68-
For more examples of accepted paths, see the [test cases](tests/urlParsing.js).
69-
7049
```javascript
7150
// Example calling /me with no parameters
7251
client
@@ -324,6 +303,29 @@ We'd love to get your feedback about the Microsoft Graph JavaScript client libra
324303

325304
## Contributing
326305
Please see the [contributing guidelines](CONTRIBUTING.md).
306+
## Changelog
307+
308+
#### 1.0.0
309+
* Added tests for new Graph functionality - Delta query, Extensibility, OneNote, and more.
310+
311+
#### 0.4.0
312+
* Add support for ES5. Make sure to use `graph-js-sdk-web.js` for web apps
313+
* Removed iterator helper method.
314+
315+
#### 0.3.1
316+
* Support for Node.js versions 4 and 5
317+
318+
#### 0.3.0
319+
* Migrated away from typings in client library core and TypeScript sample
320+
321+
#### 0.2.2
322+
* Updated SuperAgent to version ``` 3.3.0 ```
323+
324+
#### 0.2.0
325+
* **Breaking change for existing apps** - Initialize the client library with `MicrosoftGraph.Client.init({...})`. See the updated usage section below for code samples.
326+
* Added response handling tests to simulate Graph calls
327+
* Added type declarations file for core client library, which adds intellisense for chained methods.
328+
327329

328330
## Additional resources
329331

@@ -334,4 +336,4 @@ Please see the [contributing guidelines](CONTRIBUTING.md).
334336
* [Office Dev Center](http://dev.office.com/)
335337

336338
## Copyright
337-
Copyright (c) 2016 Microsoft. All rights reserved.
339+
Copyright (c) Microsoft Corporation. All rights reserved.

types-demo.PNG

33.5 KB
Loading

0 commit comments

Comments
 (0)