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.md #218

Merged
merged 1 commit into from
Mar 18, 2020
Merged

Update README.md #218

merged 1 commit into from
Mar 18, 2020

Conversation

Allanbikundo
Copy link
Contributor

@Allanbikundo Allanbikundo commented Dec 24, 2019

Hello there

So rotating-file-stream now needs one to call the function createStream to work

Copy link

@diglopes diglopes left a comment

Choose a reason for hiding this comment

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

After v2 there is no default export, you need to call "createStream" method.

@jonchurch
Copy link
Member

Closes #217

Copy link
Contributor

@dougwilson dougwilson left a comment

Choose a reason for hiding this comment

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

This keeps popping up, and in the interim there is some confusion. Can we add to the example the specific version of the rotating-file-stream the example represents?

@a10kiloham
Copy link

+1 - please push this README change; it just happened to me and had to google to get here :)

@dougwilson
Copy link
Contributor

I'm just waiting for the requested change to be made from the review comment. If I don't hear back in a week or so I will make the change myself instead, but then OP will loose credit on it, so wanted to give a chance.

@ryhinchey
Copy link
Contributor

@Allanbikundo thank for this PR! There's a request here to update the docs to reference the version of rfs that doesn't have a default export. Here's the rfs v1 > v2 upgrade docs: https://github.com/iccicci/rotating-file-stream#upgrading-from-v1xx-to-v2xx

Is this a change you can make? That seems to be the only thing left to get this PR in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants