From a672bf07685c5616557b4ecb4214eed01e47ecd5 Mon Sep 17 00:00:00 2001 From: Jayden Seric Date: Mon, 7 Oct 2024 19:37:07 +1100 Subject: [PATCH] Update the GitHub Markdown syntax for alerts in the readme. - https://github.com/orgs/community/discussions/16925 - https://github.blog/changelog/2023-12-14-new-markdown-extension-alerts-provide-distinctive-styling-for-significant-content/ - https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts --- changelog.md | 1 + readme.md | 3 +-- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/changelog.md b/changelog.md index f3b9476..134b2dd 100644 --- a/changelog.md +++ b/changelog.md @@ -48,6 +48,7 @@ - Avoid using `return` in the middleware. - Added a new dev dependency [`async-listen`](https://npm.im/async-listen) to replace the test utility function `listen`. - Enabled the TypeScript compiler options `noUnusedLocals` and `noUnusedParameters` and used the prefix `_` for purposefully unused function parameters in tests. +- Updated the GitHub Markdown syntax for alerts in the readme. ## 16.0.2 diff --git a/readme.md b/readme.md index 9a1c8e2..e3812ad 100644 --- a/readme.md +++ b/readme.md @@ -8,8 +8,7 @@ Middleware and an [`Upload`](./GraphQLUpload.mjs) scalar to add support for [Gra ## Installation -> **Note** -> +> [!TIP] > First, check if there are [GraphQL multipart request spec server implementations](https://github.com/jaydenseric/graphql-multipart-request-spec#server) (most for Node.js integrate [`graphql-upload`](https://npm.im/graphql-upload)) that are more suitable for your environment than a manual setup. To install [`graphql-upload`](https://npm.im/graphql-upload) and its [`graphql`](https://npm.im/graphql) peer dependency with [npm](https://npmjs.com/get-npm), run: