Merge pull request #55 from apal21/pre-release

Release v0.0.12
apal21 · Oct 29, 2021 · b65e34d · b65e34d
2 parents 8cc0946 + 1b0f145
commit b65e34d
Show file tree

Hide file tree

Showing 4 changed files with 3,739 additions and 729 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## v0.0.12
+### Updated:
+- Updated README.md's 'How to use' section to be more clear and consise. Also added further context to Default Config.
+- Updated Next.js version to v12
+
 ## v0.0.11
 ### Added:
 - Added next.js version 11.0.0 in package.json `peerDependancies`.

diff --git a/README.md b/README.md
@@ -11,13 +11,26 @@ npm i nextjs-progressbar
 ```
 
 ## How to use?
-After installing the package, import this in your `pages/_app.js` file.
+After installing the package, import `NextNprogress` in your `pages/_app.js` file:
 ```js
 import NextNprogress from 'nextjs-progressbar';
 ```
-And for rendering add `<NextNProgress />` inside `Container` component.
+And for rendering add `<NextNProgress />` to your `return()` in `MyApp()`:
+```js
+import NextNProgress from 'nextjs-progressbar';
+
+export default function MyApp({ Component, pageProps }) {
+  return (
+    <>
+      <NextNProgress />
+      <Component {...pageProps} />;
+    </>
+  );
+}
+```
 
 ### Default Config
+If no props are passed to `<NextNProgress />`, below is the default configuration applied.
 ```jsx
 <NextNprogress
   color="#29D"