oslllo-validator - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

CHANGELOG.md

@@ -8,2 +8,9 @@ # Changelog
 
+## [1.0.1] - 2020/10/1
+
+### Changed
+
+- Updated documentation.
+- Added `package.json` keywords.
+
 ## [1.0.0] - 2020/9/25
@@ -10,0 +17,0 @@

docs/_sidebar.md

@@ -130,2 +130,3 @@ * Getting Started
             * [`within()`](#within)
+        * [Exceptions](getting-started/basic-usage/exceptions.md)
 
@@ -132,0 +133,0 @@ * Miscellaneous

docs/getting-started/basic-usage/basic-usage.md

@@ -5,2 +5,7 @@ # Basic Usage
 
+
+### **Validator** - If you are using | [`oslllo-validator`](https://www.npmjs.com/package/oslllo-validator)
+
+![](../../images/cover-small.png)
+
 ## Node / Bundler
@@ -18,2 +23,4 @@
 
+---
+
 ### CDN
@@ -44,5 +51,52 @@
 
+---
+
+### **Validator Exception** - If you are using | [`oslllo-validator-exception`](https://www.npmjs.com/package/oslllo-validator-exception)
+
+![](../../images/cover-exception-small.png)
+
+## Node / Bundler
+
+```js
+const assert = require("oslllo-validator-exception");
+```
+
+## Browser / Client-side
+
+Both `minified` and `unminified` versions are available.
+
+> You can fetch the already built files via the `jsdelivr` CDN or by building them `locally`
+
+---
+
+### CDN
+
+- [**jsdelivr**](https://www.jsdelivr.com/package/npm/oslllo-validator-exception?path=dist)
+
+Minified
+
+```txt
+https://cdn.jsdelivr.net/npm/oslllo-validator-exception@latest/dist/oslllo-validator-exception.min.js
+```
+
+Un-minified
+
+```txt
+https://cdn.jsdelivr.net/npm/oslllo-validator-exception@latest/dist/oslllo-validator-exception.js
+```
+
+### Usage
+
+```js
+<script type="text/javascript" src="path/to/oslllo-validator-exception.min.js"></script>
+<script type="text/javascript">
+    assert.string("test"); // => True
+</script>
+```
+
+---
+
 ### Build Locally
 
-1. Clone the [repository](https://github.com/oslllo/validator) to your local machine.
+1. Clone the [repository](https://github.com/oslllo/validator-exception) to your local machine.
 2. Run `npm install --dev`.
@@ -49,0 +103,0 @@ 3. Run `npm run build`.

docs/getting-started/introduction.md

@@ -39,1 +39,9 @@
 ---
+
+## Throw `exception` on false
+
+If you want to throw an `exception` on `false` then check out `oslllo-validator-exception` [HERE](https://github.com/oslllo/validator-exception)
+
+![](../images/cover-exception-small.png)
+
+---

package.json

 {
     "name": "oslllo-validator",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "All in one Javascript validator",
@@ -49,3 +49,6 @@ "main": "src/index.js",
         "oslllo",
-        "validator"
+        "validator",
+        "javascript",
+        "all-in-one-validator",
+        "all-in-one"
     ],
@@ -52,0 +55,0 @@ "license": "MIT",

README.md

@@ -42,2 +42,8 @@
 
+## Throw `exception` on false
+
+If you want to throw an `exception` on `false` then check out `oslllo-validator-exception` [HERE](https://github.com/oslllo/validator-exception)
+
+![](./docs/images/cover-exception-small.png)
+
 ---

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1602520

increased by15.91%

Number of package files

151

increased by2.72%

Number of lines in readme file

49

increased by13.95%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes