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 <[email protected]>
gin-contrib · Nov 25, 2023 · 56a357d · 56a357d
1 parent 8fd6796
commit 56a357d
Showing 1 changed file with 4 additions and 2 deletions.
diff --git 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.