fix(AL-901): Updated README info

[MiguelTapTagshelf]

Jira Ticket: AL-901

Changes

• Updated README info to reflect a more cohesive version of the same type of info. The step by step guides have been removed and they have been replaced by an explanation of the operations that the library provides, followed by clear snippets of code examples that can be copied and tested locally.

[ejtorresm]

Overall the README is more streamlined, however I am worried there is no example on how initialize a Deferred Session and how to retrieve the information.

There are some sections that where not completely removed from previous versions, I marked them accordingly.

As a general note: we need to reduce the amount of adjectives we use in this types of documents (quick, robust, powerful, streamlined, etc.) they might be useful in more customer oriented docs but not so much for technical documents like this one.

[MiguelTapTagshelf]

@ejtorresm @rroa

All the content has been adjusted as per my first example in my first commit to the PR. All the endpoints are documented, with clear copy paste examples and brief descriptions. An outsider should be able to follow the use of the library without issues.

Please give me all the feedback that you can, if this structure holds to our standard then its the template we are going to use to document the other 2 libraries.

[rroa]

@MiguelTapTagshelf

Thank you for the thorough effort in improving the documentation for this library, especially given that it is a public one. This is definitely a step in the right direction. I do have a couple of suggestions to enhance it further:

1. Remove Results from C# Example Executions: The results included in the C# example executions seem to distort the actual response from the API. Removing these will make the examples clearer and more accurate.

2. Add Reference to HTTP API Documentation: Since this library serves as a wrapper for our HTTP API, it would be beneficial to include a reference to our HTTP API documentation. This will provide users with a more comprehensive understanding of how the library interacts with the API.

Your efforts are much appreciated, and these adjustments will help make the documentation even more valuable to our users.

[MiguelTapTagshelf]

In my last commit I removed the examples in the blocks of code in the README file and added the reference to the http docs in the overview section.

[github-actions]

🎉 This issue has been resolved in version 0.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀