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

Add getting started documentation #30

Merged
merged 2 commits into from
Apr 3, 2024

Conversation

NielsJPeschel
Copy link
Contributor

Proposed changes

Update getting started documentation to include yarn/npm commands, as well as the necessary prerequisites to utilize this package

Types of changes

What types of changes does your code introduce?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Copy link
Contributor

@robertcrockett robertcrockett left a comment

Choose a reason for hiding this comment

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

Awesome work! pnpm is starting to gain some popularity. I wonder if it makes sense to add that option for installation as well.

@NielsJPeschel
Copy link
Contributor Author

Awesome work! pnpm is starting to gain some popularity. I wonder if it makes sense to add that option for installation as well.

Great callout! I will definitely look into this and update the docs accordingly

@NielsJPeschel NielsJPeschel merged commit 76a7c8a into main Apr 3, 2024
4 checks passed
@NielsJPeschel NielsJPeschel deleted the add-getting-started-documentation branch April 3, 2024 20:04
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.

3 participants