codyframe - npm Package Compare versions

Comparing version 4.0.0 to 4.0.1

gulpfile.js

@@ -50,3 +50,4 @@ var gulp = require('gulp');
     if(file.includes('config.scss') || file.includes('util.scss')) compileGlobals('util');
+    if(file.includes('reset.scss')) compileGlobals('reset');
   });
 }));

package.json

 {
   "name": "codyframe",
-  "version": "4.0.0",
+  "version": "4.0.1",
+  "description": "The intuitive CSS framework.",
+  "keywords": [
+    "html",
+    "css",
+    "scss",
+    "sass",
+    "framework",
+    "css-framework",
+    "front-end",
+    "responsive",
+    "utility-classes",
+    "codyhouse"
+  ],
   "scripts": {
@@ -8,2 +21,3 @@ "gulp": "gulp",
   },
+  "license": "MIT",
   "devDependencies": {
@@ -16,3 +30,8 @@ "autoprefixer": "^9.4.6",
     "sass-embedded": "^1.0.0"
+  },
+  "homepage": "https://codyhouse.co",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/codyhouse/codyframe.git"
   }
 }

README.md

@@ -15,7 +15,7 @@ # CodyFrame
 
-If you prefer working with SASS, create a style.scss file and import CodyFrame:
+If you prefer working with SASS, create a style.scss file and import the CodyFrame files:
 
 ```scss
-@use 'https://unpkg.com/codyframe/main/css/reset.css'; // ← reset
-@use 'https://unpkg.com/codyframe/main/scss/config' as *; // ← customize the framework
+@use 'reset'; // ← reset
+@use 'config' as *; // ← customize the framework
 
@@ -30,7 +30,32 @@ // ↓ copy & modify these templates locally
 
-@use 'https://unpkg.com/codyframe/main/scss/util'; // ← utility classes
+@use 'util'; // ← utility classes
 ````
 
-The **_config.scss** file is used to customize the framework (i.e., to edit the breakpoints or to change the spacing scale). More info in our [documentation](https://codyhouse.co/ds/docs/framework).
+The **_config.scss** file is used to customize the framework (i.e., to edit the breakpoints or to change the spacing scale).
 
+Example:
+
+```scss
+@use 'reset';
+@use 'config' as * with (
+  $breakpoints: (
+    'sm': '48rem',
+    'md': '64rem',
+    'lg': '80rem'
+  ),
+  $font-family: (
+    'primary': 'Inter, system-ui, sans-serif'
+  ),
+  $font-size: (
+    'sm': '0.8125rem',
+    'base': '1rem',
+    'md': '1.1875rem',
+    'lg': '1.4375rem',
+    '2xl': '2.0625rem'
+  )
+);
+
+// ...
+```
+
 If you prefer working with CSS (without a preprocessor):
@@ -62,8 +87,17 @@
 
-If you install CodyFrame as npm module, remember to change the CDN links with the paths to the node module files:
+If you install CodyFrame as npm module, import the reset, config, and util modules from the node package:
 
 ```scss
-@use 'https://unpkg.com/codyframe/main/css/reset.css';
-// ↓
-@use '../../../node_modules/codyframe/main/css/reset.css';
+@use '../../../node_modules/codyframe/main/scss/reset';
+@use '../../../node_modules/codyframe/main/scss/config' as *;
+
+// ↓ copy & modify these templates locally
+@use 'typography';
+@use 'icons';
+@use 'buttons';
+@use 'forms';
+
+// ← import here the CodyHouse components
+
+@use '../../../node_modules/codyframe/main/scss/util';
 ```
@@ -70,0 +104,0 @@

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

574212

increased by1.74%

Number of package files

21

increased by5%

Lines of code

21971

increased by1.04%

Number of low maintenance alerts

1

decreased by-50%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

110

increased by44.74%

Number of low supply chain risk alerts

0

decreased by-100%

No dependency changes