Skip to content

Commit 8bf19e1

Browse files
committed
Update doc
1 parent fe6501e commit 8bf19e1

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

README.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,24 @@
22

33
![diol-main-banner](/content/images/diol-main-banner.png)
44

5-
`D`otnet `I`nput-`O`utput `L`ogger (`Diol`) is a free and open-source tool created by dotnet.
5+
Dotnet Input-Output Logger (`Diol`) is a **free** and **open-source** Visual Studio extension created by dotnet.
66

77
With `Diol` you can easily see and explore logs during debugging your `dotnet` application in real time.
88

9-
Let's say **stop** for tons of log messages in our code!
9+
**Stop** making tons of log messages in our code!
1010

1111
## Features
1212

1313
* **99.9%** zero touch approach. Just plug and play!
14-
* **No need** to install any external dependencies to your project
15-
* **No need** to modify your existing code
14+
* **No need** to install any external dependencies to your project or modify your soruce code
1615
* Supports next log types:
17-
* **Http** requests and responces
18-
* **Aspnet core** (controllers and minimal API)
19-
* **SQL** (Entity Framework)
16+
* **HttpClient** requests and responces
17+
* **Aspnet core** controllers and minimal API
18+
* **SQL** via Entity Framework
2019
* **Web sockets & SignalR** (comming soon)
2120
* **gRPC** (comming soon)
2221
* 3rd party **SDK** can be integrated as well (_1_)
2322

24-
### Additional feature
25-
26-
Our backend service is available for you to integrate with your own UI app. It's free and easy to use, and it offers many features and benefits. To learn more, please visit [diol backend service doc](https://github.com/Dotnet-IO-logger/core/wiki/1.-Diol-backend-service).
27-
2823
## How to use
2924

3025
We have a [guide](https://github.com/Dotnet-IO-logger/core/wiki/1.-Getting-started-guide) how to install and use `Diol` but in short:
@@ -37,11 +32,28 @@ We have a [guide](https://github.com/Dotnet-IO-logger/core/wiki/1.-Getting-start
3732

3833
### DEMOs
3934

40-
We prepared **5 minute** demo projects for each DIOL feature you may want to check:
35+
We have prepared DEMOs on how to set up and use DIOL, and we’ve divided them by areas.
36+
37+
The DEMOs are pre-set and straightforward.
38+
39+
You don’t need to create anything from scratch or write any code.
40+
41+
Please feel free to use them for your personal learning or for making DEMO for your audience.
42+
43+
| Name | Duration | Description |
44+
| :--- | :--- | :--- |
45+
| [HttpClient demo](https://github.com/Dotnet-IO-logger/Playground/tree/main/source/Diol.Demo/src/Example1HttpLoggingSample) | ~5 minutes | How to setup DIOL to for HttpClient logs |
46+
| [AspNET endpoints demo](https://github.com/Dotnet-IO-logger/Playground/tree/main/source/Diol.Demo/src/Example2AspnetEndpointLoggingSample) | ~5 minutes | How to setup DIOL for asp.net endpoints and controllers logs |
47+
| **EntityFramework** | x | Comming soon... |
48+
49+
## Additional feature
50+
51+
In case if you want to reuse DIOL logic for your application you may want to check [diol backend service doc](https://github.com/Dotnet-IO-logger/core/wiki/1.-Diol-backend-service).
52+
53+
Highlights:
4154

42-
* [HttpClient demo](https://github.com/Dotnet-IO-logger/Playground/tree/main/source/Diol.Demo/src/Example1HttpLoggingSample)
43-
* [AspNET endpoints demo](https://github.com/Dotnet-IO-logger/Playground/tree/main/source/Diol.Demo/src/Example2AspnetEndpointLoggingSample)
44-
* **EntityFramework demo** is comming soon...
55+
* **Easy to install**: Distributed as a dotnet cli command. Can be installed via `dotnet isntall` command
56+
* **SignalR service**: Supports realtime notification for each log
4557

4658
## Feedback and contribution
4759

0 commit comments

Comments
 (0)