Skip to content

Commit 897ada6

Browse files
upd: readme
1 parent c4a9841 commit 897ada6

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@ Please check [DynamicsWebApi Wiki](../../wiki/) where you will find documentatio
1010

1111
Libraries for browsers can be found in [dist](/dist/) folder.
1212

13-
If you find this library useful or it saved your time, please feel free to donate [![PayPal.Me](/extra/paypal.png)](https://paypal.me/alexrogov).
14-
15-
Any suggestions and contributions are welcome!
13+
Any [suggestions and contributions](#contributions) are welcome!
1614

1715
**Important!** For some reason, npm was not removing `.git` folder from a published package,
1816
even though [it should have done it by default](https://docs.npmjs.com/misc/developers#keeping-files-out-of-your-package), therefore
@@ -72,6 +70,7 @@ please go to `node_modules\dynamics-web-api` of your application and remove `.gi
7270
* [Making requests using Entity Logical Names](#making-requests-using-entity-logical-names)
7371
* [JavaScript Promises](#javascript-promises)
7472
* [JavaScript Callbacks](#javascript-callbacks)
73+
* [Contributions](#contributions)
7574

7675
## Getting Started
7776

@@ -173,7 +172,7 @@ var dynamicsWebApi = new DynamicsWebApi({ webApiVersion: '9.0' });
173172

174173
```js
175174
var dynamicsWebApi = new DynamicsWebApi({
176-
webApiUrl: 'https:/myorg.api.crm.dynamics.com/api/data/v9.0/',
175+
webApiUrl: 'https://myorg.api.crm.dynamics.com/api/data/v9.0/',
177176
onTokenRefresh: acquireToken
178177
});
179178
```
@@ -194,7 +193,7 @@ maxPageSize | Number | Defaults the odata.maxpagesize preference. Use to set the
194193
onTokenRefresh | Function | A callback function that triggered when DynamicsWebApi requests a new OAuth token. (At this moment it is done before each call to Dynamics 365, as [recommended by Microsoft](https://msdn.microsoft.com/en-ca/library/gg327838.aspx#Anchor_2)).
195194
returnRepresentation | Boolean | Defaults Prefer header with value "return=representation". Use this property to return just created or updated entity in a single request.
196195
useEntityNames | Boolean | `v.1.4.0+` Indicates whether to use entity logical names instead of collection logical names during requests.
197-
webApiUrl | String | A complete URL string to Web API. Example of the URL: "https:/myorg.api.crm.dynamics.com/api/data/v8.2/". If it is specified then webApiVersion property will not be used even if it is not empty.
196+
webApiUrl | String | A complete URL string to Web API. Example of the URL: "https://myorg.api.crm.dynamics.com/api/data/v8.2/". If it is specified then webApiVersion property will not be used even if it is not empty.
198197
webApiVersion | String | Version of the Web API. Default version is "8.0".
199198

200199
Configuration property `webApiVersion` is required only when DynamicsWebApi used inside CRM.
@@ -1868,7 +1867,7 @@ the config option "formatted" will enable developers to retrieve all information
18681867
- [X] Entity and Attribute Metadata helpers. `Implemented in v.1.4.3`
18691868
- [X] Entity Relationships and Global Option Sets helpers. `Implemented in v.1.4.6`
18701869
- [X] Batch requests.
1871-
- [ ] Implement `Content-ID` header to reference a created entity in batch operation.
1870+
- [ ] Implement `Content-ID` header to reference a created entity in a batch operation.
18721871
- [ ] Intellisense for request objects.
18731872

18741873
Many more features to come!
@@ -1882,3 +1881,16 @@ It is highly recommended to use one of the Promise Polyfills (Yaku, ES6 Promise
18821881

18831882
## JavaScript Callbacks
18841883
Please use the following library that implements Callbacks : [DynamicsWebApi with Callbacks](/scripts/dynamics-web-api-callbacks.js).
1884+
1885+
## Contributions
1886+
1887+
First of all, I would like to thank you for using `DynamicsWebApi` library in your Dynamics 365 CE project, the fact that my project helps someone to achieve their development goals already makes me happy.
1888+
1889+
And if you would like to contribute to the project you may do it in multiple ways:
1890+
1. Submit an issue/bug if you have encountered one.
1891+
2. If you know the root of the issue please feel free to submit a pull request, just make sure that all tests pass and if the fix needs new unit tests, please add one.
1892+
3. Let me and community know if you have any ideas or suggestions on how to improve the project by submitting an issue on GitHub, I will label it as a 'future enhancement'.
1893+
4. Feel free to connect with me on [LinkedIn](https://www.linkedin.com/in/alexrogov/) and if you wish to let me know how you use `DynamicsWebApi` and what project you are working on, I will be happy to hear about it.
1894+
5. If you feel that this project saved your time and you would like to support it, then please feel free to donate: [![PayPal.Me](/extra/paypal.png)](https://paypal.me/alexrogov)
1895+
1896+
Any contribution is greatly appreciated!

0 commit comments

Comments
 (0)