bulma-start - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

package.json

 {
   "name": "bulma-start",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Start package for Bulma",
@@ -12,11 +12,16 @@ "keywords": [
   "author": "Jeremy Thomas <[e-mail]> (http://jgthms.com)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jgthms/bulma-start.git"
+  },
   "license": "MIT",
   "devDependencies": {
-    "autoprefixer": "^7.1.5",
+    "autoprefixer": "^9.4.7",
     "babel-cli": "^6.26.0",
-    "babel-preset-env": "^1.6.0",
+    "babel-preset-env": "^1.7.0",
     "babel-preset-es2015-ie": "^6.7.0",
-    "bulma": "^0.6.0",
-    "node-sass": "^4.5.3",
-    "postcss-cli": "^4.1.1"
+    "bulma": "^0.7.2",
+    "node-sass": "^4.11.0",
+    "npm-run-all": "^4.1.5",
+    "postcss-cli": "^6.1.1"
   },
@@ -31,4 +36,4 @@ "scripts": {
     "js-watch": "npm run js-build -- --watch",
-    "start": "npm run css-watch | npm run js-watch"
+    "start": "npm-run-all --parallel css-watch js-watch"
   }
 }

README.md

@@ -1,1 +0,106 @@
-Start package for [Bulma](http://bulma.io)
+# Start package for [Bulma](http://bulma.io)
+
+Tiny npm package that includes the `npm` **dependencies** you need to **build your own website** with Bulma.
+
+<a href="http://bulma.io"><img src="https://raw.githubusercontent.com/jgthms/bulma-start/master/bulma-start.png" alt="Bulma: a Flexbox CSS framework" style="max-width:100%;" width="600" height="315"></a>
+
+## Install
+
+```sh
+npm install bulma-start
+```
+_or_
+
+```sh
+yarn add bulma-start
+```
+
+## What's included
+
+The `npm` dependencies included in `package.json` are:
+
+* <code>[bulma](https://github.com/jgthms/bulma)</code>
+* <code>[node-sass](https://github.com/sass/node-sass)</code> to compile your own Sass file
+* <code>[postcss-cli](https://github.com/postcss/postcss-cli)</code> and <code>[autoprefixer](https://github.com/postcss/autoprefixer)</code> to add support for older browsers
+* <code>[babel-cli](https://babeljs.io/docs/usage/cli/)</code>, <code>[babel-preset-env](https://github.com/babel/babel-preset-env)</code> and <code>[babel-preset-es2015-ie](https://github.com/jmcriffey/babel-preset-es2015-ie)</code> for compiling ES6 JavaScript files
+
+Apart from `package.json`, the following files are included:
+
+* `.babelrc` configuration file for [Babel](https://babeljs.io/)
+* `.gitignore` common [Git](https://git-scm.com/) ignored files
+* `index.html` this HTML5 file
+* `_sass/main.scss` a basic SCSS file that **imports Bulma** and explains how to **customize** your styles, and compiles to `css/main.css`
+* `_javascript/main.js` an ES6 JavaScript that compiles to `lib/main.js`
+
+
+## Get your feet wet
+
+This package is meant to provide a **good starting point** for working with Bulma.
+
+When installing this package with the commands above, it landed in `$HOME/node_packages/bulma-start`.
+In order to use it as a **template** for your **project**, you might consider copying it to a better suited location:
+
+```sh
+cd $HOME/projects
+cp -a $HOME/node_modules/bulma-start my-bulma-project
+```
+
+Alternatively, you could do something similar with a GitHub clone as well.
+
+```sh
+cd $HOME/projects
+git clone https://github.com/jgthms/bulma-start
+mv bulma-start my-bulma-project
+rm -rf my-bulma-project/.git     # cut its roots
+```
+
+Now, that you prepared the groundwork for your project, set up Bulma and run the watchers:
+
+```sh
+cd my-bulma-project
+npm install
+npm start
+```
+
+As long as `npm start` is running, it will **watch** your changes. You can edit `_sass/main.scss` and `_javascript/main.js` at will. Changes are **immediately** compiled to their destinations, where `index.html` will pick them up upon reload in your browser.
+
+Some controlling output is written to the `npm start` console in that process:
+
+```sh
+_javascript/main.js -> lib/main.js
+
+=> changed: $HOME/projects/start-with-bulma/_sass/main.scss
+Rendering Complete, saving .css file...
+Wrote CSS to $HOME/projects/start-with-bulma/css/main.css
+```
+
+Use `npm run` to show all available commands:
+
+```sh
+Lifecycle scripts included in bulma-start:
+  start
+    npm-run-all --parallel css-watch js-watch
+
+available via `npm run-script`:
+  css-build
+    node-sass _sass/main.scss css/main.css
+  css-deploy
+    npm run css-build && npm run css-postcss
+  css-postcss
+    postcss --use autoprefixer --output css/main.css css/main.css
+  css-watch
+    npm run css-build -- --watch
+  deploy
+    npm run css-deploy && npm run js-build
+  js-build
+    babel _javascript --out-dir lib
+  js-watch
+    npm run js-build -- --watch
+```
+
+If you want to learn more, follow these links: [Bulma homepage](http://bulma.io) and [Documentation](http://bulma.io/documentation/overview/start/).
+
+
+## Copyright and license
+
+Code copyright 2017 Jeremy Thomas. Code released under [the MIT license](https://github.com/jgthms/bulma-start/blob/master/LICENSE).

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

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

Improved metrics

Total package byte prevSize

673452

increased by10.76%

Number of package files

11

increased by10%

Number of lines in readme file

107

increased by5250%

Number of low supply chain risk alerts

0

decreased by-100%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

8

increased by14.29%

Lines of code

6424

decreased by-5.21%

No dependency changes