This is the official JS / TS SDK for the Radix Name Service. For detailed implementation examples, please view the following developer documentation: https://docs.rns.foundation/#/developers/sdk-setup

Compatibility

The SDK is compatible within:

• All modern browsers.
• Node v18 and above.

Installation

    npm i @radixnameservice/rns-sdk

Contributing to Radix Name Service (RNS) SDK

We welcome contributions to the Radix Name Service (RNS) SDK from the community. Whether you want to report a bug, propose a feature, or contribute code, your input is valuable. If you wish to contribute to the RNS SDK:

1. Fork the repository: https://github.com/radixnameservice/sdk

2. Clone your fork locally:

   git clone https://github.com/your-username/sdk.git
   cd sdk
   

3. Install dependencies:

   npm install
   

4. Create a new branch for your changes:

   git checkout -b my-feature-branch
   

5. Make your changes and ensure the code features corresponding tests (passing).

6. Add and commit your changes:

   git add .
   git commit -m "Add new feature or fix issue"
   

7. Push your branch to your fork:

   git push origin my-feature-branch
   

8. Submit a pull request:

   • Visit your fork on GitHub.
   • Create a pull request for your changes.
   • Provide a clear title and description for your pull request, explaining the purpose of your changes.
   • Follow up with any feedback or requested changes from maintainers.

Code Review

All contributions go through a code review process. Be prepared to address any feedback and make additional changes if necessary.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please report any unacceptable behavior to the project maintainers.

Thank you for contributing to the Radix Name Service SDK! 🚀