Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework typescript SDK README document #732

Merged
merged 8 commits into from
Nov 2, 2023
Merged

Rework typescript SDK README document #732

merged 8 commits into from
Nov 2, 2023

Conversation

lukasz-zimnoch
Copy link
Member

@lukasz-zimnoch lukasz-zimnoch commented Nov 2, 2023

Refs: #699

Here we rework the SDK README document by dividing it into three main sections:

  • Quickstart that targets integrators and explains how to install and use the SDK in an external project
  • Contributing that targets contributors and explains how to set up the SDK for development
  • Documentation that links to the comprehensive documentation on the Threshold Network GitBook

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's package.json to properly display the SDK repository in the npm registry.

Push some small updates to the root `README` document.
Here we rework the SDK `README` document by providing basic guidance for
both contributors and integrators.

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
and. Moreover, we do not use AsciiDoc features in this file anyway.
@lukasz-zimnoch lukasz-zimnoch self-assigned this Nov 2, 2023
@lukasz-zimnoch lukasz-zimnoch added the 📖 documentation Improvements or additions to documentation label Nov 2, 2023
@lukasz-zimnoch lukasz-zimnoch added this to the typescript/v2.2.0 milestone Nov 2, 2023
@tomaszslabon tomaszslabon merged commit 80605fc into main Nov 2, 2023
38 checks passed
@tomaszslabon tomaszslabon deleted the sdk-readme branch November 2, 2023 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants