Rework typescript SDK README
document
#732
Merged
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.
Refs: #699
Here we rework the SDK
README
document by dividing it into three main sections:Apart from that, we are changing the file type from
*.adoc
to*.md
. This is because only Markdown files are properly displayed in the npm registry. Moreover, we do not use AsciiDoc features in this file anyway.Last but not least, this PR introduces some small updates to the repository-level
README
and sets repository info in the SDK'spackage.json
to properly display the SDK repository in the npm registry.