Update README with improved descriptions and usage guide #94
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The README tutorial has been heavily updated to provide more depth and clarity on how to work with the package. It includes an enhanced usage guide, focusing on local running first, while presenting the steps in writing simple examples. Some inaccuracies and redundancies, particularly in the logging section, have been rectified. The explanations on using Eventstream and setting up a remote actor have been improved for better understanding.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The README tutorial has been heavily updated to provide more depth and clarity on how to work with the package. It includes an enhanced usage guide, focusing on local running first, while presenting the steps in writing simple examples. Some inaccuracies and redundancies, particularly in the logging section, have been rectified. The explanations on using Eventstream and setting up a remote actor have been improved for better understanding.