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.

Sign up for GitHub

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

Jump to bottom

docs: update the comments in .env.example#L33-L42 #130

Closed
Flouse opened this issue May 8, 2024 · 2 comments · Fixed by #139
Closed

docs: update the comments in .env.example#L33-L42 #130

Flouse opened this issue May 8, 2024 · 2 comments · Fixed by #139
Assignees
@ahonn
Labels
documentation Improvements or additions to documentation

Comments

@Flouse
Copy link
Contributor

Flouse commented May 8, 2024 •
edited
Loading

https://github.com/ckb-cell/btc-assets-api/blob/9e29e0199d8a6a4037c90a3173bcf6e2b7e83f22/.env.example#L33-L42

electrs is the default Bitcoin data provider.
@Flouse Flouse added the documentation Improvements or additions to documentation label May 8, 2024
@ahonn ahonn linked a pull request May 17, 2024 that will close this issue
docs: update .env.example and simplify default env vars #139
Merged
@ahonn
Copy link
Collaborator

ahonn commented May 17, 2024 •
edited
Loading

Open a PR: #139 for update .env.example. In the meantime, simplify default environment variables.
Users/developers should reach out in src/env.ts for more optional environment variables. This will reduce the workload of document maintenance. Only the environment variables that need to be strongly aware need to be updated in the readme and .env.example files.

@Flouse
Copy link
Contributor Author

Flouse commented May 17, 2024 •
edited
Loading

Only the environment variables that need to be strongly aware need to be updated in the readme and .env.example files.

Make sense

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ahonn ahonn

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: update .env.example and simplify default env vars utxostack/btc-assets-api
2 participants
@Flouse @ahonn