Skip to content
This repository was archived by the owner on Apr 10, 2018. It is now read-only.

Commit 16913e2

Browse files
committed
Updated documentation
1 parent 1ad44c3 commit 16913e2

1 file changed

Lines changed: 21 additions & 17 deletions

File tree

README.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,16 @@ This is some kind of a RestSharp port to PCL.
88

99
# Changes #
1010

11+
## 3.1.1 ##
12+
13+
* Fix for [issue #57](https://github.com/FubarDevelopment/restsharp.portable/issues/57) (thanks to zevsst)
14+
1115
## 3.1.0 ##
1216

1317
This is the final release for version 3. Be aware that version 3.1 contains many **breaking changes**:
1418

15-
* The ```IRestRequest.Credentials``` property moved to ```IRestClient.Credentials```
16-
* Credentials for authenticators are specified using the ```IRestClient.Credentials``` property
19+
* The `IRestRequest.Credentials` property moved to `IRestClient.Credentials`
20+
* Credentials for authenticators are specified using the `IRestClient.Credentials` property
1721
* New core library that contains all interfaces and other generic stuff
1822
* New interface for proxies
1923
* New interfaces that are an abstraction of the HttpClient and its request/response messages
@@ -29,7 +33,7 @@ This is the final release for version 3. Be aware that version 3.1 contains many
2933

3034
* Async locking fixes (provided by [evnik](https://github.com/evnik))
3135
* OAuth 1.0 fixes (required for Twitter)
32-
* UTF-8 encoding for characters like ```\u2764\uFE0F``` (❤️)
36+
* UTF-8 encoding for characters like `\u2764\uFE0F` (❤️)
3337
* Use [EscapeUriString](https://msdn.microsoft.com/de-de/library/system.uri.escapeuristring.aspx) compatible URL encoding for query parameters
3438

3539
## 3.0.0 beta 09 ##
@@ -38,7 +42,7 @@ Fix endless loop for OAuth2 and failed requests when a refresh token is availabl
3842

3943
## 3.0.0 beta 07 ##
4044

41-
Remember the OAuth2 refresh token when calling the ```GetCurrentToken``` function with a set
45+
Remember the OAuth2 refresh token when calling the `GetCurrentToken` function with a set
4246
refresh token. This should fix the problem with exiring access tokens.
4347

4448
## 3.0.0 beta 06 ##
@@ -57,14 +61,14 @@ refresh token. This should fix the problem with exiring access tokens.
5761

5862
## 3.0.0 beta 02 ##
5963

60-
* Support more headers when using ```HttpWebRequest``` instead of ```HttpClient```
61-
* New ```UserAgent``` property for ```IRestClient```
62-
* Activated automatic decompression for ```HttpClient``` and ```HttpWebRequest```
64+
* Support more headers when using `HttpWebRequest` instead of `HttpClient`
65+
* New `UserAgent` property for `IRestClient`
66+
* Activated automatic decompression for `HttpClient` and `HttpWebRequest`
6367

6468
## 3.0.0 beta 01 ##
6569

66-
* Refactoring to reduce source code duplication by adding a ```RestClientBase``` class
67-
* Allow customization of ```HttpWebRequest``` creation to allow the usage of client certificates
70+
* Refactoring to reduce source code duplication by adding a `RestClientBase` class
71+
* Allow customization of `HttpWebRequest` creation to allow the usage of client certificates
6872
* Support for RSA-SHA1 for platforms with full .NET Framework support
6973
* New OAuth 1.0 test that uses [oauthbin.com](http://oauthbin.com)
7074

@@ -97,15 +101,15 @@ refresh token. This should fix the problem with exiring access tokens.
97101
## 3.0.0 alpha 3 ##
98102

99103
* Revamped authenticator interfaces
100-
* Provide a way to process the ```Www-Authenticate``` header
101-
* Make HTTP Basic/Digest authenticators work with ```Proxy-Authenticate``` header
102-
* Credentials property moved from ```IRestRequest``` to ```IRestClient```
104+
* Provide a way to process the `Www-Authenticate` header
105+
* Make HTTP Basic/Digest authenticators work with `Proxy-Authenticate` header
106+
* Credentials property moved from `IRestRequest` to `IRestClient`
103107
* The NTLM authenticator is not needed anymore, because the the credentials from
104-
the ```IRestRequest``` are automatically used in the ```HttpClientHandler``` which handles
108+
the `IRestRequest` are automatically used in the `HttpClientHandler` which handles
105109
the Basic/Digest/NTLM authentication automatically
106110
* All authenticators should query the credentials passed to the authenticator
107-
* New ```AuthenticationChallengeHandler``` which selects one of the registered
108-
authenticators in response to a ```Www-Authenticate``` or ```Proxy-Authenticate``` challenge.
111+
* New `AuthenticationChallengeHandler` which selects one of the registered
112+
authenticators in response to a `Www-Authenticate` or `Proxy-Authenticate` challenge.
109113
* New Gitter OAuth 2.0 client
110114

111115
## 2.4.5 ##
@@ -133,7 +137,7 @@ refresh token. This should fix the problem with exiring access tokens.
133137

134138
## 2.4.0 ##
135139

136-
* New ```Timeout``` property to fix issue [#13](https://github.com/FubarDevelopment/restsharp.portable/issues/13) with [CancellationTokenSource.CancelAfter](https://msdn.microsoft.com/de-de/library/hh194678%28v=vs.110%29.aspx)
140+
* New `Timeout` property to fix issue [#13](https://github.com/FubarDevelopment/restsharp.portable/issues/13) with [CancellationTokenSource.CancelAfter](https://msdn.microsoft.com/de-de/library/hh194678%28v=vs.110%29.aspx)
137141

138142
## 2.3.2 ##
139143

@@ -279,7 +283,7 @@ We use the class with:
279283
```csharp
280284
using (var client = new RestClient(new Uri("https://www.bitstamp.net/api/")))
281285
{
282-
var request = new RestRequest("ticker", HttpMethod.Get);
286+
var request = new RestRequest("ticker", Method.GET);
283287
var result = await client.Execute<TickerResult>(request);
284288
}
285289
```

0 commit comments

Comments
 (0)