Update readme with simple example how to use this library

[nvborisenko]

Update readme with simple example how to use this library

[nvborisenko]

Easiest and great possibility to do it would be using dotnet-try interactive tool for documentation. We will describe samples, and user will be able to execute these samples.

[winstondz]

Some of the examples, I see use the CreateLogItemRequest which I think is depreciated. How do we attach a file (screenshot) using this package? Is there an example (stackoverflow) you can point me to?

[nvborisenko]

@winstondz example how to send log message with binary attachment: https://github.com/reportportal/client-net/blob/a0bc6f8129cc8ba9f43786b15caa519568a01b3d/test/ReportPortal.Client.IntegrationTests/LogItem/LogItemFixture.cs#L51

[unickq]

2 years, no docs 🤒

[nvborisenko]

Only one entry point:

var service = new Service(uri, project, token);

Then intellisense does a magic. For instance start new launch:

var launch = await service.Launch.StartAsync(new StartLaunchRequest.......

Feel free to contribute, dn't hesitate to propose requests for change. Hoping test project describes how to use this library (covers 83% of code).

PS: inline doc instructions doesn't work, we need choose good library for inheritance of inline documentation.

Roadmap options:

• just readme file
• jupyter notebooks where you can play within predefined examples interactively
• centralized doc for the whole RP.NET world