laradumps-js 0.1.4 → 0.1.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 LaraDumps
+
+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.

package/README.md

@@ -0,0 +1,99 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/laradumps/laradumps-core/refs/heads/2.x/art/logo.png" height="128" alt="" />
+</p>
+<h1 align="center">LaraDumps Js</h1>
+
+<div align="center">
+  <p align="center">
+    <a href="https://www.npmjs.com/package/laradumps-js">
+      <img alt="Total Downloads" src="https://img.shields.io/npm/dm/laradumps-js">
+    </a>
+    <a href="https://www.npmjs.com/package/laradumps-js">
+      <img alt="Latest Version" src="https://img.shields.io/npm/v/laradumps-js">
+    </a>
+    <a href="https://github.com/laradumps/laradumps-js/actions">
+        <img alt="Tests" src="https://github.com/laradumps/laradumps-js/workflows/Node.js%20CI/badge.svg" />
+    </a>
+    <a href="https://www.npmjs.com/package/laradumps-js">
+      <img alt="License" src="https://img.shields.io/github/license/laradumps/laradumps-js">
+    </a>
+  </p>
+</div>
+
+### 👋 Hello Dev,
+
+<br/>
+
+LaraDumps is a user-friendly application designed to boost your coding and debugging experience.
+
+When using LaraDumps, you can see your debugging results displayed in a standalone Desktop application.
+
+### Get Started
+
+#### Web
+
+1. Add the min script to your header.
+
+```html
+<script src="
+https://cdn.jsdelivr.net/npm/laradumps-js/dist/laradumps.min.js
+"></script>
+ ```
+   
+2. Add a `ds()` function somewhere in your code.
+
+---
+
+#### NodeJs | ReactJs | React Native
+
+1. Install LaraDumps Js in your project, run the command:
+
+```shell
+yarn add -D laradumps-js
+npm install -D laradumps-js
+```
+
+2. Import the Laradumps Js
+
+```Javascript
+import {ds} from 'laradumps-js'
+```
+or
+```Javascript
+import 'laradumps-js'
+```
+
+3. Add a `ds()` function somewhere in your code.
+
+#### Vite
+
+1. Install LaraDumps Js in your project, run the command:
+
+```shell
+yarn add -D laradumps-js
+npm install -D laradumps-js
+```
+
+2. Import Laradumps Js inside bootstrap
+
+```Javascript
+import 'laradumps-js'
+```
+
+3. Add a `ds()` function somewhere in your code.
+
+Here's an example:
+
+```js
+//... some JS code ...
+
+ds('Hello from LaraDumps!').info();
+```
+
+### Credits
+
+- Author: [Luan Freitas](https://github.com/luanfreitasdev)
+
+- Contribution: [Hecktor Viegas](https://github.com/hecktorvn)
+
+- Logo by [Vitor S. Rodrigues](https://github.com/vs0uz4)