blaze-css - npm Package Compare versions

Comparing version 1.8.4 to 1.8.5-old

package.json

 {
   "name": "blaze-css",
-  "version": "1.8.4",
-  "description": "Open Source UI Toolkit - CSS",
-  "main": "dist/blaze.min.css",
-  "files": [
-    "src/",
-    "dist/"
-  ],
-  "publishConfig": {
-    "access": "public"
+  "version": "1.8.5-old",
+  "description": "Open Source UI Toolkit",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BlazeUI/blaze.git"
   },
@@ -28,16 +24,10 @@ "keywords": [
     "stencil",
-    "stenciljs",
-    "monorepo"
+    "stenciljs"
   ],
   "author": "Gregory Pratt",
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/BlazeUI/blaze.git"
-  },
   "bugs": {
     "url": "https://github.com/BlazeUI/blaze/issues"
   },
-  "homepage": "https://www.blazeui.com",
-  "gitHead": "97b607c039b3afce9a7134b865f8908a123ff25e"
+  "homepage": "https://www.blazeui.com"
 }

README.md

@@ -1,3 +0,11 @@
-# <a href="https://www.blazeui.com">Blaze CSS</a>
+# Please use separate <a href="https://www.npmjs.com/org/blaze">@blaze packages</a> 
 
+Blaze has moved to scoped packages under <a href="https://www.npmjs.com/org/blaze">@blaze</a>.
+
+This makes it easier for you to install only what you need and allows us to name and organise our packages how we'd like.
+
+---
+
+# <a href="https://www.blazeui.com">Blaze</a>
+
 Blaze is a framework-free open source UI toolkit. It provides great structure for building websites quickly with a scalable and maintainable foundation.
@@ -9,24 +17,37 @@
 
-## Installing the CSS
+## Local Developer Setup
 
-The easiest way to use the toolkit is via CDN.
+First of all install [NVM](https://github.com/creationix/nvm#install-script).
 
-```html
-<link rel="stylesheet" href="https://unpkg.com/blaze-css@x.x.x/dist/blaze.min.css">
+When that is complete run:
+
+```cli
+$ nvm use
+$ npm i
 ```
 
-The `x.x.x` is the specific version of the library, you should use specifc versions to prevent against breaking changes.
+That's essentially it! Here are some useful commands:
 
-### Modules
+| `npm run <command>` | Description                                                        |
+| ------------------- | :----------------------------------------------------------------- |
+| test                | Lints all the scss files and runs all the tests on the atoms       |
+| dev                 | Runs the dev servers with live reloads for both scss and atoms     |
+| commit              | To commit any changes please use `npm run commit`, more info below |
 
-Each module is also available via CDN in-case you only want bits and pieces of Blaze and not the whole toolkit.
+### Committing
 
+When committing changes please follow the [Conventional Commits](https://conventionalcommits.org/) format.
+
+The best thing to do is simply run **`npm run commit`** and it'll take you through a step-by-step wizard.
+
+## Installing the CSS
+
+The easiest way to use the toolkit is via CDN.
+
 ```html
-<link rel="stylesheet" href="https://unpkg.com/blaze-css@x.x.x/dist/generics.global.min.css">
-<link rel="stylesheet" href="https://unpkg.com/blaze-css@x.x.x/dist/objects.grid.min.css">
-<link rel="stylesheet" href="https://unpkg.com/blaze-css@x.x.x/dist/utilities.typography.min.css">
-<link rel="stylesheet" href="https://unpkg.com/blaze-css@x.x.x/dist/components.buttons.min.css">
-...etc...
+<link rel="stylesheet" href="https://unpkg.com/@blaze/css@x.x.x/dist/blaze.css">
 ```
 
+The `x.x.x` is the specific version of the library, you should use specifc versions to prevent against breaking changes.
+
 ### How to start applying styles
@@ -36,3 +57,3 @@
 
-The following won't change by simply linking to blaze.min.css like it would with others such as Bootstrap or Foundation:
+The following won't change by simply linking to blaze.css like it would with others such as Bootstrap or Foundation:
 
@@ -50,1 +71,17 @@ ```html
 This means you have to add classes to each part of your site where you want Blaze to apply. Take a look at the documentation for our objects, components, typography etc. and you'll see how intuitive it is to use.
+
+## Installing the JavaScript Components
+
+Link to it by adding the following to your `<head></head>`.
+
+```html
+<script src="https://unpkg.com/@blaze/atoms@x.x.x/dist/blaze-atoms.js"></script>
+```
+
+The `x.x.x` is the specific version of the library, you should use specifc versions to prevent against breaking changes.
+
+That's it! Start using the components in your HTML.
+
+### Integrating with a Framework
+
+Blaze uses [Stencil](http://stenciljs.com/) to compile our components into Web Components. And since they can be used within frameworks or in standard HTML websites the best resource to read is the [Stencil documentation](https://stenciljs.com/docs/overview) regarding framework integration.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Improved metrics

Number of medium maintenance alerts

0

decreased by-100%

Number of lines in readme file

85

increased by77.08%

Worsened metrics

Total package byte prevSize

3815

decreased by-98.81%

Number of package files

2

decreased by-98.32%

Number of low quality alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes