Skip to content

Commit 64bbe0c

Browse files
author
Hassan Faghihi
committed
Update Readme & Docs
1 parent 0ba8da9 commit 64bbe0c

File tree

2 files changed

+26
-20
lines changed

2 files changed

+26
-20
lines changed

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# AdvancedRestHandler
2-
A utility code that can be used to request Data from services... <br/>
2+
A utility code that can be used to request Data from services...
33

4-
This library is based on my exprience and need of working in the past company, taking many services in. I could handle any request so far using it, and every time I felt it doesn't support my need, i tried to expand it.
4+
This library is based on my experience and need of working in the past company, taking many services in. I could handle any request so far using it, and every time I felt it doesn't support my need, i tried to expand it.
55

6-
[![NuGet](https://img.shields.io/badge/nuget-v1.4.0-blue)](https://www.nuget.org/packages/AdvancedRestHandler/)
6+
[![NuGet](https://img.shields.io/badge/nuget-v1.5.0-blue)](https://www.nuget.org/packages/AdvancedRestHandler/)
77

88
First install the package using following commands, or download it manually from release section...
99

1010
```powershell
11-
Install-Package AdvancedRestHandler -Version 1.4.0
11+
Install-Package AdvancedRestHandler -Version 1.5.0
1212
```
1313
or
1414
```sh
15-
dotnet add package AdvancedRestHandler --version 1.4.0
15+
dotnet add package AdvancedRestHandler --version 1.5.0
1616
```
1717

1818
Then you can use the library.
@@ -23,18 +23,21 @@ AdvancedRestHandler arh = new AdvancedRestHandler([baseUrl], [fixEndOfUrl]);
2323
TResponse response = arh.GetData<TResponse>(url, [options]);
2424
```
2525

26-
in the above code, in the `AdvancedRestHandler` constructor: <br/>
27-
-`baseUrl` is a fixed part of url in a service, which can also be null <br/>
28-
-`fixEndOfUrl` is to automatically attach path as resource in a way that base url of "https://test.test" and calling a operation service of "the-service" had a result of "https://test.testthe-service" or in the other hand, base url of "https://test.test/" and a service url of "/the-service" would result in "https://test.test//the-service", but with this option which is true by default, it will result in "https://test.test/the-service". but due to some services, which they think of '/' as part of the path, and it's existance mean different route, I kept the flag, so it can be turned off. <br/>
26+
in the above code, in the `AdvancedRestHandler` constructor:
27+
28+
-`baseUrl` is a fixed part of url in a service, which can also be null
29+
-`fixEndOfUrl` is to automatically attach path as resource in a way that base url of "https://test.test" and calling a operation service of "the-service" had a result of "https://test.testthe-service" or in the other hand, base url of "https://test.test/" and a service url of "/the-service" would result in "https://test.test//the-service", but with this option which is true by default, it will result in "https://test.test/the-service". but due to some services, which they think of '/' as part of the path, and it's existance mean different route, I kept the flag, so it can be turned off.
2930

30-
in the `GetData`: <br/>
31-
-`TResponse` is the type of data you are receiving and the incoming json or (i'm not sure if i pars XML, but if supported XML) should be deserialized to <br/>
32-
-`url` depending on the existance of baseUrl can be either the full url to a service, or the versitile part of the path in the service url <br/>
33-
-`options` are modifier that can affect the behaviour of the service <br/>
31+
in the `GetData`:
32+
33+
- `TResponse` is the type of data you are receiving and the incoming json or (i'm not sure if i pars XML, but if supported XML) should be deserialized to
34+
- `url` depending on the existance of baseUrl can be either the full url to a service, or the versitile part of the path in the service url
35+
- `options` are modifier that can affect the behaviour of the service
3436

35-
Also note that request can be: <br/>
36-
-A premitive <br/>
37-
-A Type <br/>
38-
-A Type inherited from ArhResponse <br/>
39-
-An object of type ArhResponse<[Your Type]> <br/>
40-
-An object of type ArhStringResponse <br/>
37+
Also note that request can be:
38+
39+
- A premitive
40+
- A Type
41+
- A Type inherited from ArhResponse
42+
- An object of type ArhResponse<[Your Type]>
43+
- An object of type ArhStringResponse

_Docs/push nuget github package.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,11 @@ $ dotnet nuget add source https://nuget.pkg.github.com/deadmann/index.json -n gi
33
// if already exists....: dotnet nuget remove source github
44
// if key update is required: https://github.com/settings/tokens
55

6-
// Step 2: Pack
6+
// Step 2: Build
7+
$ dotnet build --configuration Release
8+
9+
// Step 3: Pack
710
$ dotnet pack --configuration Release
811

9-
// Step 3: Publish
12+
// Step 4: Publish
1013
$ dotnet nuget push "bin/Release/AdvancedRestHandler.1.0.0.nupkg" --source "github"

0 commit comments

Comments
 (0)