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

feat: document code and update the README with usage instructions #7

Merged
merged 1 commit into from
Feb 29, 2024

Conversation

r-marques
Copy link
Member

Description

  • Added code documentation
  • Added tsdoc plugin to eslint
  • Update README with instructions on how to use the library

Is this PR related with an open issue?

Related to Issue nevermined-io/tutorials#38

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • Follows the code style of this project.
  • Tests Cover Changes
  • Documentation

Funny gif

Put a link of a funny gif inside the parenthesis-->

* ```
*
* @returns An instance of {@link Payments}
*/
constructor(options: PaymentOptions) {
this.returnUrl = options.returnUrl
this.environment = Environments[options.environment]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use in the environment options the same environment "names" we use in the SDK and CLI:
https://github.com/nevermined-io/sdk-js/blob/676dc1c9ef51cde02309bdc5214e804a7b9ea67f/src/nevermined/resources/AppNetworks.ts#L23

@eruizgar91 eruizgar91 merged commit bdf72f4 into main Feb 29, 2024
1 check passed
@eruizgar91 eruizgar91 deleted the feat/add-documentation branch February 29, 2024 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants