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

Updates 4 project READMEs #42

Merged
merged 9 commits into from
Jan 6, 2023
Merged

Updates 4 project READMEs #42

merged 9 commits into from
Jan 6, 2023

Conversation

kyle-n
Copy link
Contributor

@kyle-n kyle-n commented Dec 28, 2022

  • Standardizes format for ORM READMEs
  • Links to ORM concepts referenced in documentation
  • Installation instructions that specify which package to install
  • Links in ORM READMEs to top-level README for monorepo
  • Updates install command to not use --save since that has been default behavior in NPM for a while
  • Removes duplicate library documentation in top-level README

@kyle-n kyle-n added the documentation Improvements or additions to documentation label Dec 28, 2022
@kyle-n kyle-n linked an issue Dec 28, 2022 that may be closed by this pull request
Make readmes navigable #34
Closed
michael-dean-haynie
michael-dean-haynie approved these changes Jan 6, 2023
View reviewed changes
Copy link
Collaborator

@michael-dean-haynie michael-dean-haynie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it. Thanks @kyle-n!

@kyle-n kyle-n merged commit 32ee84d into main Jan 6, 2023
@kyle-n kyle-n deleted the readme-fixes branch January 6, 2023 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michael-dean-haynie michael-dean-haynie michael-dean-haynie approved these changes

@RoyAyo RoyAyo Awaiting requested review from RoyAyo

@phillipskevin phillipskevin Awaiting requested review from phillipskevin

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

Successfully merging this pull request may close these issues.

Make readmes navigable
2 participants
@kyle-n @michael-dean-haynie