docs: add readme and license files (#1)

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Victor Ribeiro Boechat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,83 @@
+# Network Error Handling
+
+## Introduction
+
+A powerful error handling to manage network axios response errors.
+
+## Installation
+
+```bash
+npm install network-error-handling
+```
+
+```bash
+yarn add network-error-handling
+```
+
+```bash
+pnpm install network-error-handling
+```
+
+## Usage
+
+1. Import
+
+```typescript
+import { networkErrorHandling } from "network-error-handling";
+```
+
+2. Call the function, example:
+
+```typescript
+networkErrorHandling(error)
+  .addError(
+    StatusCode.CONFLICT,
+    "User already exists",
+    "The user already exists, please try again with another email.",
+    () => console.log("Error while creating user")
+  )
+  .handle();
+```
+
+## Using toast
+
+If you plan to display a toast of error, you will need to have a function to handle the toast, example using Shadcn
+UI toast component
+
+```typescript
+import { toast } from "shadcn-components-folder-location/use-toast";
+
+export const handleErrorToast = (title: string, description: string) =>
+  toast({ title, description, variant: "error" });
+```
+
+After this, you can use the `withToast` method to handle the toast, example:
+
+```typescript
+networkErrorHandling(error)
+  .addError(
+    StatusCode.CONFLICT,
+    "User already exists",
+    "The user already exists, please try again with another email."
+  )
+  .withToast(handleErrorToast)
+  .handle();
+```
+
+Ooh, you can also use a callback function when using a toast!
+
+```typescript
+networkErrorHandling(error)
+  .addError(
+    StatusCode.CONFLICT,
+    "User already exists",
+    "The user already exists, please try again with another email.",
+    () => console.log("Error while creating user")
+  )
+  .withToast(handleErrorToast)
+  .handle();
+```
+
+## License
+
+[MIT](LICENSE.md)