Skip to content

Commit a64960b

Browse files
Gourav DwivediGourav Dwivedi
authored andcommitted
modify readme.md
1 parent b013c3f commit a64960b

File tree

2 files changed

+51
-16
lines changed

2 files changed

+51
-16
lines changed

README.md

Lines changed: 49 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
11
# SignalR-Web-Client
2-
ASP.Net Core Signal R JavaScript based Web Client
2+
ASP.Net Core Signal-R Web Client is based on JavaScript
33

44

5-
This is a UI based ASP.Net Core SignalR client. It is used to test SignalR Hub. It is a debugging tool to test ASP.Net Core SignalR hubs. Using this tool, we can send the data to the SignalR hub and receive the response emit from the Signal R Hub. This tool is design for dotnet developer to make their life easier when they work with SignalR.
5+
This is a UI based SignalR client. It is a debugging tool to test ASP.Net Core SignalR hubs. Using this tool, we can send the data to the SignalR hub and receive the response emit from the SignalR Hub. This tool is design for dotnet developer to make their life easier when they work with SignalR.
66

7+
## Table of Contents
8+
9+
- [Basic Understanding of](#Basic-Understanding-of)
10+
- [Install](#install)
11+
- [Usage](#usage)
12+
- [Examples & Demos](#examples--demos)
13+
- [API](#api)
14+
- [Contribute](#contribute)
15+
- [License](#license)
16+
17+
18+
## Basic Understanding of:
19+
20+
Before using this should, you should be know few concepts about:
21+
22+
- [What is Asp.Net Core?](https://dotnet.microsoft.com/learn/aspnet/what-is-aspnet-core)
23+
- [What is SignalR in Asp.Net Core?](https://docs.microsoft.com/en-us/aspnet/core/signalr/introduction?view=aspnetcore-3.0)
724

825
<p align="center">
926
<img src="./src/images/SignalR-Web-Client.jpg" >
@@ -20,16 +37,16 @@ SignalR Web Client have two views:
2037
1. Basic
2138
2. Advance
2239

23-
## Baisc
40+
### Baisc View
2441

25-
In this basic view, you can contact to hub by providing the hub address. And to can start
42+
In this basic view, you can contact to hub by providing the hub address.
2643

27-
1. Pass the valid Hub address in Service Endpoint textbox.(for ex. https://localhost:5001/Test/OneHub).
44+
1. Pass the valid Hub address in Hub Address textbox.(for ex. https://localhost:5001/Test/OneHub).
2845
<img src="./src/images/1.PNG" width="600px" height="400px" />
2946

3047
2. Once click on Connect button, it will make connection with server. Once the connection is established, if any data is broadcast from the Hub(ex. OneHub) to all the client. Then, it will be displayed in Response payload textbox.
3148

32-
3. If we want to test any Hub method. For exmaple
49+
3. If we want to call any Hub method. For exmaple TesCall method
3350
```csharp
3451
public class OneHub : Hub
3552
{
@@ -40,22 +57,35 @@ public class OneHub : Hub
4057
}
4158
}
4259
```
43-
So, in the tool, we have to pass the parameter.
60+
In the tool, we have to pass the parameter.
4461

45-
Server Method: TestCall
46-
Request Payload: It can take multiple parameters. In our example, TestCall method only taking one parameter of type string.
47-
ex. Arg: abc
48-
Type: Text
62+
#### Server Method:
63+
TestCall
4964

50-
Currently Data Type supports: Text, Number & JSON
65+
#### Request Payload:
66+
It can take multiple parameters. In our example, TestCall method only taking one parameter of type string.
67+
ex. Arg: abc
68+
Type: Text
69+
70+
#### Data Type supports:
71+
Text, Number & JSON
5172

5273
<img src="./src/images/5.PNG" width="300px" height="300px" />
5374

5475
Then click on send button. It will send all the data to the hub.
5576

5677
<img src="./src/images/3.PNG" />
5778

58-
## Advance
79+
### Advance View
80+
81+
It has all the functionality which basic view provides, also it has additional features:
82+
- Authentication Header
83+
- Transport Type ([To know more about SignalR Transport](https://kevgriffin.com/signalr-transports-explained/))
84+
85+
<img src="./src/images/2.PNG" />
86+
87+
## Browser Support
88+
Currently it supports only chrome browser.
5989

6090
### Reporting Issues
6191

@@ -68,4 +98,9 @@ Then, just open a [new clear and descriptive issue](../../issues/new).
6898

6999
## License
70100

71-
[MIT License](https://opensource.org/licenses/MIT)
101+
[MIT License](https://opensource.org/licenses/MIT)
102+
103+
---
104+
Copyright &copy; 2019,
105+
Created by [Gourav Dwivedi](https://github.com/gouravdwivedi6590).
106+
Released under the terms of the [MIT license](https://github.com/gouravdwivedi6590/SignalR-Web-Client/blob/master/LICENSE).

src/js/components/srform.component.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ class SrFormComponent extends HTMLElement {
3838
</div>
3939
4040
<div class="form-group row">
41-
<label for="inputUrl" class="col-sm-2 col-form-label">Service Endpoint</label>
41+
<label for="inputUrl" class="col-sm-2 col-form-label">Hub Address</label>
4242
<div class="col-sm-10">
4343
<input type="text" class="form-control inputUrl" id="inputUrl" placeholder="Url" value="https://localhost:5001/Test/OneHub">
4444
</div>
@@ -62,7 +62,7 @@ class SrFormComponent extends HTMLElement {
6262
</div>
6363
6464
<div class="form-group row onconnect" ${divStyle} id="protocol-support">
65-
<label class="col-sm-2 col-form-label">Protocol Supported</label>
65+
<label class="col-sm-2 col-form-label">Transport Type</label>
6666
<div class="col-sm-10 offset-sm-2">
6767
<div class="form-check form-check-inline">
6868
<input type="checkbox" id="chk-ws" class="form-check-input protocol-support" value="ws" checked/>

0 commit comments

Comments
 (0)