Skip to content

Update README #64

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

Update README #64

skedwards88 wants to merge 1 commit into from

Conversation

@skedwards88
Copy link
Contributor

@skedwards88 skedwards88 commented Dec 17, 2025 •
edited
Loading

  • Update the README to link to the docs instead of hardcoding examples here, so that we only have one place to maintain examples
  • Consolidate all other info into a "Contributing" section
    • Omitted the section on running integration tests for HCD since this section was incomplete/nearly empty
    • Omitted the "Collections" section under testing since this section was empty
    • Adjusted formatting to meet the CommonMark specification
    • Minor wording updates
    • Omitted curl commands from the local quickstart section since they seemed irrelevant to the client and added a lot of bulk (definitely ok to revert this since it is very much out of scope)

Preview: https://github.com/datastax/astra-db-java/blob/f4b6752b91653694c3b37570437b05ec1255fabb/README.MD

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

@skedwards88