From 56a357d11cabc0c2bf25e02b7b20340630eef95a Mon Sep 17 00:00:00 2001 From: Bo-Yi Wu Date: Sat, 25 Nov 2023 14:41:17 +0800 Subject: [PATCH] docs: update documentation with additional notes - Fix a typo in the README.md file - Add a note about the difference between Default() and DefaultConfig() functions - Add a note about the implications of using all origins in Gin Signed-off-by: Bo-Yi Wu --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e0db826..d435232 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,8 @@ func main() { router.Run() } ``` -note: while Default() allows all origins, DefaultConfig() does not and you will still have to use AllowAllOrigins + +Note: while Default() allows all origins, DefaultConfig() does not and you will still have to use AllowAllOrigins. ### Default() allows all origins @@ -90,4 +91,5 @@ func main() { router.Run() } ``` -Using all origins disables the ability for Gin to set cookies for clients. When dealing with credentials, don't allow all origins + +Using all origins disables the ability for Gin to set cookies for clients. When dealing with credentials, don't allow all origins.