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

doc: add CONFIGURATION.md #20

Merged
merged 3 commits into from
Oct 26, 2022
Merged

doc: add CONFIGURATION.md #20

merged 3 commits into from
Oct 26, 2022

Conversation

cameri
Copy link
Owner

@cameri cameri commented Oct 25, 2022

Description

  1. Document the environment variables and settings file

Related Issue

#19

Motivation and Context

Without proper documentation, someone looking to run nostr-ts-relay would need to look in the code to understand what the different environment variables and settings are and their purpose.

How Has This Been Tested?

Testing not needed.

Screenshots (if appropriate):

Types of changes

  • 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:

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

@cameri cameri linked an issue Oct 25, 2022 that may be closed by this pull request
@cameri cameri self-assigned this Oct 25, 2022
@coveralls
Copy link
Collaborator

coveralls commented Oct 25, 2022

Pull Request Test Coverage Report for Build 3325726496

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 70.588%

Totals Coverage Status
Change from base Build 3309014838: 0.0%
Covered Lines: 466
Relevant Lines: 685

💛 - Coveralls

@cameri cameri merged commit 3fbebaf into main Oct 26, 2022
@cameri cameri deleted the 19-document-settings branch October 26, 2022 02:33
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.

Document settings
2 participants