Skip to content

README improvements #13

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
Open
sirdavos47 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README improvements #13

sirdavos47 wants to merge 1 commit into from

Conversation

@sirdavos47
Copy link

@sirdavos47 sirdavos47 commented Oct 28, 2025

  • Description:
    • Rewrite and expand README.md to include clearer setup instructions, explicit security warnings about private keys, configuration notes, API endpoint descriptions and curl examples.
    • Add links to key files and highlight important symbols used by the server (e.g. walletPrivateKey, web3, cEthContract).
    • Recommend follow-up improvements (JSON responses, env config, validation, tests).
  • Files changed:

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

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@sirdavos47