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

Update README to give install and usage instructions. #17

Merged
merged 2 commits into from
Dec 19, 2024

Conversation

cleve-fauna
Copy link
Collaborator

Problem

This package is now on npm but we have instructions as if it is still private and can only be used locally. ## Solution
Give install and usage instructions.

Testing

I'm following the guide here to use this on an internal npm package.

Please suggest any alternatives or additoins.

## Problem
This package is now on npm but we have instructions as if it is still private and can only be used locally.
## Solution
Give install and usage instructions.
## Testing
I'm following the guide here to use this on an internal npm package.

Please suggest any alternatives or additoins.
@cleve-fauna cleve-fauna requested review from echo-bravo-yahoo and a team December 19, 2024 14:14
Copy link
Collaborator Author

@cleve-fauna cleve-fauna left a comment

Choose a reason for hiding this comment

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

Text fixes

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ptpaterson ptpaterson left a comment

Choose a reason for hiding this comment

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

LGTM. I have not additions to make.

@cleve-fauna cleve-fauna merged commit ab12b48 into main Dec 19, 2024
1 check passed
@cleve-fauna cleve-fauna deleted the main_updateReadme branch December 19, 2024 14:44
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