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.

Sign up for GitHub

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

Jump to bottom

Integrate all-contributors bot #16

Merged
merged 4 commits into from
Oct 16, 2023
Merged

Integrate all-contributors bot #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
af5c5a5
Integrate all-contributors bot
neg4n Oct 10, 2023
77fe9f1
Add path to the README in .github directory for the bot
neg4n Oct 10, 2023
dcf84c3
Move README and improve writing
neg4n Oct 10, 2023
fcea826
Fix all-contributorsrc
neg4n Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .all-contributorsrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"projectName": "next-api-compose",
"projectOwner": "neg4n",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"README.md"
]
}
21 changes: 17 additions & 4 deletions .github/README.md → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@

## Introduction

This library provides a hassle-free way of composing multiple middleware functions into one [Next.js API Route Handler][next-api-route-handlers]'s method in the **[App Directory][next-app-router-intro]** router.
This library provides a hassle-free way of composing multiple middleware functions into one [Next.js API Route Handler][next-api-route-handlers]'s method in the **[App Directory][next-app-router]** router.

> [!IMPORTANT]
> The `2.0.0` version of the library supports both [app] and pages directory API utilities. If you're still using Pages Router and you want to migrate from versions below `2.0.0`, please read [migration guide](./MIGRATE_V2.md).
> The `2.0.0` version of the library supports both [app][next-app-router] and [pages][next-app-router] directory oriented API utilities. If you're still using Pages Router and you want to migrate from versions below `2.0.0`, please read [migration guide](./.github/MIGRATE_V2.md) and ocassionally consider checking out [intro to the App Router][next-app-router-intro].

## Features

Expand Down Expand Up @@ -86,9 +86,22 @@ export { GET };

2. Middleware is executed as specified in the per-method array, so if you want to execute middleware in a specific order, you have to be careful about it. Early returned `new Response()` halts the middleware chain.

## License and contributions
## Contributors

The project is licensed under The MIT License. Thanks for all the contributions! Feel free to open an issue or a pull request.
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

## License and acknowledgements

The project is licensed under The MIT License. Thanks for all the contributions! Feel free to open an issue or a pull request even if it is just a question 🙌

[next-api-route-handlers]: https://nextjs.org/docs/app/building-your-application/routing/route-handlers
[next-app-router-intro]: https://nextjs.org/docs/app/building-your-application/routing#the-app-router
[next-app-router]: https://nextjs.org/docs/app
[next-pages-router]: https://nextjs.org/docs/pages