Merge pull request #5 from ndom91/patch-1

docs: update README.md

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,51 @@
+<!--
+Thanks for your interest in the project. Bugs filed and PRs submitted are appreciated!
+
+Please make sure that you are familiar with and follow the Code of Conduct for
+this project (found in the CODE_OF_CONDUCT.md file).
+
+Also, please make sure you're familiar with and follow the instructions in the
+contributing guidelines (found in the CONTRIBUTING.md file).
+
+If you're new to contributing to open source projects, you might find this free
+video course helpful: https://kcd.im/pull-request
+
+Please fill out the information below to expedite the review and (hopefully)
+merge of your pull request!
+-->
+
+## Reasoning 💡
+
+<!--
+What changes are being made? What feature/bug is being fixed here?
+
+IMPORTANT: Which, if any, adapter is being affected? Or are you wanting to add
+a new one?
+ -->
+
+## Checklist 🧢
+
+<!-- Feel free cross items ( like this `~[] item~` ) if they're irrelevant to your changes.
+
+To check an item, place an `x` in the box like so: `- [x] Documentation`. -->
+
+- [ ] Documentation
+- [ ] Tests
+- [ ] Ready to be merged
+
+<!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->
+
+## Affected issues 🎟
+
+<!--
+Please [scout and link issues](https://github.com/nextauthjs/react-query/issues) that might be solved by this PR.
+
+If you write `"Fixes"` or `"Closes"` before the issue link like so:
+
+```
+Fixes #359
+```
+
+the connected issue will be automatically closed once the PR is merged and hence help with maintenance of the library 😊
+
+-->

.github/stale.yml

@@ -0,0 +1,25 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 90
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 14
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+  - priority
+  - bug
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  Hi there! It looks like this issue hasn't had any activity for a while.
+  It will be closed if no further activity occurs. If you think your issue
+  is still relevant, feel free to comment on it to keep it open.
+  Thanks!
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: >
+  Hi there! It looks like this issue hasn't had any activity for a while.
+  To keep things tidy, I am going to close this issue for now.
+  If you think your issue is still relevant, just leave a comment
+  and I will reopen it.
+  Thanks!

.github/workflows/lint.yml

@@ -0,0 +1,26 @@
+name: Lint Package
+
+on:
+  push:
+    branches: 
+     - main
+     - canary
+  pull_request:
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        node-version: [10, 12, 14]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        uses: bahmutov/npm-install@v1
+
+      - run: npm run test:ci

README.md

@@ -1,12 +1,11 @@
 <p align="center">
   <img alt="Next Auth logo"
     src="https://next-auth.js.org/img/logo/logo-sm.png"
-    height="32" />&nbsp;&nbsp;&nbsp;&nbsp;<img alt="plus sign" src="https://www.svgrepo.com/show/138538/plus-sign.svg"
-    height="24" />&nbsp;&nbsp;&nbsp;&nbsp;<img alt="React Query logo" src="https://react-query.tanstack.com/_next/static/images/logo-a65f848e05592e7de1dc2150454230fa.svg"
-    height="32" />&nbsp;&nbsp;&nbsp;&nbsp;<img alt="equal sign" src="https://www.svgrepo.com/show/106212/equal.svg"
-    height="24" /> &nbsp;&nbsp;<img alt="heart"
-    src="https://upload.wikimedia.org/wikipedia/commons/3/35/Emoji_u2665.svg" height="24" />
-  <h3 align="center">@next-auth/react-query</h3>
+    height="64" />&nbsp;&nbsp;&nbsp;&nbsp;<img alt="plus sign" src="https://www.svgrepo.com/show/138538/plus-sign.svg"
+    height="48" />&nbsp;&nbsp;&nbsp;&nbsp;<img alt="React Query logo" src="https://react-query.tanstack.com/_next/static/images/logo-a65f848e05592e7de1dc2150454230fa.svg"
+    height="64" />
+  <h3 align="center">NextAuth.js React-Query Client</h3>
+  <p align="center">@next-auth/react-query</p>
   <p align="center">React Query wrapper for NextAuth.js session management.</p>
   <p align="center" style="align: center;">
     <a href="https://www.npmtrends.com/@next-auth/react-query">
@@ -22,6 +21,18 @@
   </p>
 </p>
 
+## Overview
+
+This is an alternative client for `next-auth` based upon [`react-query`](https://react-query.tanstack.com/). It can replace the built-in session management on the client-side by taking advantage of `react-query`'s built-in caching, auto refetching, etc.
+
+## Getting Started
+
+```
+npm install --save @next-auth/react-query
+```
+
+You can then import `useSession` from this package, instead of the core `next-auth` package. More usage details can be found below.
+
 
 ## API Reference
 
@@ -71,3 +82,11 @@ The [shape](https://github.com/nextauthjs/next-auth/blob/88ec3bad71eb60ed86b3d95
 ## Acknowledgements
 
 Based on [this discussion](https://github.com/nextauthjs/next-auth/discussions/1803) between [@kripod](https://github.com/kripod) and [@balazsorban44](https://github.com/balazsorban44)
+
+## Contributing
+
+We're open to all community contributions! If you'd like to contribute in any way, please first read our [Contributing Guide](https://github.com/nextauthjs/next-auth/blob/canary/CONTRIBUTING.md).
+
+## License
+
+ISC