ZEBEDEE API documentation / readme cleanup - Githubissues

cameri / nostream

A Nostr Relay written in TypeScript

MIT License

715 stars 185 forks source link

ZEBEDEE API documentation / readme cleanup #308

Closed andrerfneves closed 1 year ago

andrerfneves commented 1 year ago

Description

Cleaning up the docs / readme related to ZEBEDEE API integration

refactor: cleanup URL + readme docs for ZEBEDEE API integration with Nostream

Related Issue

https://github.com/Cameri/nostream/issues/307

Motivation and Context

Want to ensure Nostream operators have all the context on how to best setup/run their paid relays

How Has This Been Tested?

By the ZEBEDEE eng team.

Types of changes

[x] Non-functional change (docs, style, minor refactor)
[ ] 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:

[x] My code follows the code style of this project.
[x] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.
[x] I have read the CONTRIBUTING document.
[ ] I have added tests to cover my code changes.
[x] All new and existing tests passed.

coveralls commented 1 year ago

Pull Request Test Coverage Report for Build 4998051086

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.2%) to 55.273%

Totals
Change from base Build 4982804961:	0.2%
Covered Lines:	1250
Relevant Lines:	2229

💛 - Coveralls

sonarcloud[bot] commented 1 year ago

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

github-actions[bot] commented 1 year ago

:tada: This PR is included in version 1.24.1 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: