search

apal21 / nextjs-progressbar

A simple Next.js progressbar component using NProgress.
https://www.npmjs.com/package/nextjs-progressbar
MIT License
786 stars 62 forks source link

Improvement: Make Readme Better #46

Closed atawfique21 closed 2 years ago

atawfique21 commented 3 years ago

Hey there, great package you have here and other than the confusing installation instructions, I think this is a great plug & play package. Great work 🍾

I really suggest updating the readme as this is quite confusing: And for rendering add <NextNProgress /> inside Container component.

Not everyone has a Container component and I now understand after the fact that Container is codename for any larger Context but this isn't very clear. Thanks to issue: #6, I figured out that I just needed to include <NextNProgress /> anywhere in the MyApp() return() scope for it to render.

Just a suggestion, perhaps I was the only one confused.

apal21 commented 3 years ago

I'm glad that you liked the package. And also thanks for pointing this thing out.

What could be the better approach for this? Could you please raise a PR if you have something on your mind?