|
1 |
| -# NextAuth.js |
2 |
| - |
3 |
| - |
4 |
| - |
| 1 | +<p align="center"> |
| 2 | + <br/> |
| 3 | + <a href="https://next-auth.js.org" target="_blank"><img width="150px" src="https://next-auth.js.org/img/logo/logo-sm.png" /></a> |
| 4 | + <br/> |
| 5 | + <h3 align="center">NextAuth.js</h3> |
| 6 | + <p align="center">Authentication for Next.js</p> |
| 7 | + <br/> |
| 8 | + <p align="center"> |
| 9 | + Open Source. Full Stack. Own Your Data. |
| 10 | + </p> |
| 11 | + <p align="center" style="align: center;"> |
| 12 | + <img src="https://github.com/nextauthjs/next-auth/workflows/Build%20Test/badge.svg" alt="Build Test" /> |
| 13 | + <img src="https://github.com/nextauthjs/next-auth/workflows/Integration%20Test/badge.svg" alt="Integration Test" /> |
| 14 | + <img src="https://img.shields.io/bundlephobia/minzip/next-auth" alt="Bundle Size"/> |
| 15 | + <img src="https://img.shields.io/npm/dm/next-auth" alt="Downloads" /> |
| 16 | + <img src="https://img.shields.io/github/issues-pr/nextauthjs/next-auth" alt="Github Pull Requests" /> |
| 17 | + <img src="https://img.shields.io/github/stars/nextauthjs/next-auth" alt="Github Stars" /> |
| 18 | + <img src="https://img.shields.io/github/v/release/nextauthjs/next-auth?include_prereleases" alt="Github Release" /> |
| 19 | + </p> |
| 20 | +</p> |
5 | 21 |
|
6 | 22 | ## Overview
|
7 | 23 |
|
8 | 24 | NextAuth.js is a complete open source authentication solution for [Next.js](http://nextjs.org/) applications.
|
9 | 25 |
|
10 | 26 | It is designed from the ground up to support Next.js and Serverless.
|
11 | 27 |
|
12 |
| -[Follow the examples](https://next-auth.js.org/getting-started/example) to see how easy it is to use NextAuth.js for authentication. |
| 28 | +## Getting Started |
| 29 | + |
| 30 | +``` |
| 31 | +npm install --save next-auth |
| 32 | +``` |
| 33 | + |
| 34 | +The easiest way to continue getting started, is to follow the [getting started](https://next-auth.js.org/getting-started/example) section in our docs. |
13 | 35 |
|
14 |
| -Install: `npm i next-auth` |
| 36 | +We also have a section of [tutorials](https://next-auth.js.org/tutorials) for those looking for more specific examples. |
15 | 37 |
|
16 | 38 | See [next-auth.js.org](https://next-auth.js.org) for more information and documentation.
|
17 | 39 |
|
@@ -52,13 +74,15 @@ Advanced options allow you to define your own routines to handle controlling wha
|
52 | 74 |
|
53 | 75 | ### Typescript
|
54 | 76 |
|
55 |
| -This library gained Typescript support recently. You can install the types in the following way: |
| 77 | +You can install the appropriate types via the following command: |
| 78 | + |
56 | 79 | ```
|
57 |
| -$ npm i -D @types/next-auth |
| 80 | +npm install --save-dev @types/next-auth |
58 | 81 | ```
|
59 |
| -In you encounter any issue with them, please raise an issue and add the "typescript" label to it, we'll try to help you with it as soon as possible. |
60 | 82 |
|
61 |
| -Alternatively you can raise a PR directly with your fixes on [**DefinitelyTyped**](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/next-auth). |
| 83 | +If you encounter any problems with the types package, please create an issue and add the `typescript` label to it. |
| 84 | + |
| 85 | +Alternatively, you can open a pull request directly with your fixes on the [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/next-auth) repository, where you'll find a `next-auth` subfolder. |
62 | 86 |
|
63 | 87 | ## Example
|
64 | 88 |
|
@@ -116,14 +140,18 @@ export default function myComponent() {
|
116 | 140 | }
|
117 | 141 | ```
|
118 | 142 |
|
119 |
| -## Acknowledgement |
120 |
| - |
121 |
| -[NextAuth.js is possible thanks to its contributors.](https://next-auth.js.org/contributors) |
| 143 | +## Acknowledgements |
122 | 144 |
|
123 |
| -## Getting started |
| 145 | +[NextAuth.js is made possible thanks to all of its contributors.](https://next-auth.js.org/contributors) |
124 | 146 |
|
125 |
| -[Follow the examples to get started.](https://next-auth.js.org/getting-started/example) |
| 147 | +<a href="https://github.com/nextauthjs/next-auth/graphs/contributors"> |
| 148 | + <img width="500px" src="https://contrib.rocks/image?repo=nextauthjs/next-auth" /> |
| 149 | +</a> |
126 | 150 |
|
127 | 151 | ## Contributing
|
128 | 152 |
|
129 |
| -If you'd like to contribute to you can find useful information in our [Contributing Guide](https://github.com/iaincollins/next-auth/blob/main/CONTRIBUTING.md). |
| 153 | +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/iaincollins/next-auth/blob/main/CONTRIBUTING.md). |
| 154 | + |
| 155 | +## License |
| 156 | + |
| 157 | +ISC |
0 commit comments