doc(readme): add cors notice

DerStimmler · Aug 27, 2023 · aedeb16 · aedeb16
1 parent 3f59e82
commit aedeb16
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 [![codecov](https://codecov.io/gh/DerStimmler/ts-ulm-dsl/branch/master/graph/badge.svg?token=HZ7AKB0UUA)](https://codecov.io/gh/DerStimmler/ts-ulm-dsl)
 [![GitHub license](https://img.shields.io/github/license/DerStimmler/ts-ulm-dsl)](https://github.com/DerStimmler/ts-ulm-dsl/blob/master/LICENSE.md)
 
-Typescript library for fetching emails from the temp mail service [ulm-dsl](https://ulm-dsl.de/).
+Typescript library for fetching emails from the temp mail service [ulm-dsl](https://ulm-dsl.de/)
 
 ## Installation
 
@@ -25,6 +25,8 @@ Every method is async and therefore returns a promise. You can either use `await
 
 Note that you have to fetch your inbox once before you can receive emails at your address. Your address stays active for 14 days. This period renews for every request.
 
+Furthermore there are no CORS headers included in the api response. Accordingly, CORS errors may occur when using this library in a browser.
+
 ### Initialization
 
 Just import the client from your node_modules.

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "ts-ulm-dsl",
 	"version": "2.0.0",
-	"description": "Typescript library for fetching emails from the temp mail service ulm-dsl.",
+	"description": "Typescript library for fetching emails from the temp mail service ulm-dsl",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"scripts": {