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

README rewrite #297

Merged
merged 2 commits into from
Jan 28, 2023
Merged

README rewrite #297

merged 2 commits into from
Jan 28, 2023

Conversation

tjburch
Copy link
Collaborator

@tjburch tjburch commented Dec 11, 2022

Overhaul README to be somewhat less verbose and to-the-point. Aimed to reduce the number of full dataframe printouts we had, raise the full docs folder to be more visible. Some notes:

  • Removed the version number. It's on git, so it should be clear by the sidebar
  • Removed the changelog link. Git has an internal changelog that we seem to be better about using.
  • I think it makes sense for contributing.md to be a contributing guide rather than suggestions on things to add. So I wrote it as if that's the future paradigm. We'll need to update contributing.md correspondingly.

Has the discord link so supersedes #292. I'll take that one down.

@schorrm
Copy link
Collaborator

schorrm commented Dec 11, 2022

LGTM in general, I would put the discord link at the top though

@schorrm schorrm merged commit 0462b63 into jldbc:master Jan 28, 2023
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.

2 participants