Merge pull request #99 from geotrev/develop

fixes to scripts/ for consistent release versioning and hash creation

Author: geotrev

README.md

@@ -126,10 +126,10 @@ Clone the repo and re-clone the wiki contents.
 ```sh
 $ git clone git@github.com:USER_NAME/undernet.git
 $ cd undernet/
-$ npm run setup
+$ npm install
 ```
 
-The site is both a demo and marketing tool. It is built with my own webpack setup called [Pulsar](https://github.com/geotrev/pulsar). It's basically just Webpack + React, so don't panic.
+The site is both a demo and marketing tool. It is built with my own webpack setup called [Pulsar](https://github.com/geotrev/pulsar). It's basically just Webpack + React, so don't panic. :)
 
 ### Run the dev server
 
@@ -183,18 +183,19 @@ $ npm run js:watch
 
 ### New releases
 
-New releases are simply zipped and compiled files.
+New releases are simply zipped and compiled files to be distributed on npm, then for use on a CDN, such as jsdelivr.
 
-To increment the version of the release, run the following command, where `VERSION` is the semver value. E.g., `--tag=2.3.0`. The script will find specific files: `package.json`, `scss/undernet.scss`, and `docs/introduction.md`. It then increments the version, creates new sub-resource integrity hashes, and updates unpkg.com links for CDN access.
+To run a release build, run the following two commands, where `VERSION` is the semver value incremented from `package.json`:
 
 ```sh
 $ update-version --tag=VERSION
+$ npm run build:release
 ```
 
-Then to build assets:
+These will do three things:
 
-```sh
-$ npm run build:release
-```
+1. Increment the project version across multiple files that require it.
+2. Build all assets with the new version.
+3. Generate new sha-256 hashes for CDN access (see `docs/introduction.md`, "Get Started" section).
 
-All that's left is a `npm publish` and the new version is out in the wild!
+All that's left is a `npm publish` and the new version is out in the wild! Crazy cool!

dist/undernet.bundle.js

@@ -6,14 +6,14 @@ Undernet is extremely light, carrying no external dependencies apart from needin
 
 ## Get Started
 
-The quickest way to use Undernet is to link the bundled js and minified css using a CDN, such as [unpkg](https://www.unpkg.com).
+The quickest way to use Undernet is to link the bundled js and minified css using a CDN, such as [jsdelivr](https://jsdelivr.com).
 
 ```html
-<link rel="stylesheet" href="https://unpkg.com/undernet@2.4.0/dist/undernet.min.css" integrity="sha256-aCt3hDWtL1yGzwbbOIz38YAgMVIrMJygL18UZSJ34Tk=" crossorigin="anonymous">
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/undernet@2.4.1/dist/undernet.min.css" integrity="sha256-bX29Vc8vjuAFBJS+PKK2r9iJOj1aMLn4A1Sj8iH63BM=" crossorigin="anonymous">
 ```
 
 ```html
-<script type="text/javascript" src="https://unpkg.com/undernet@2.4.0/dist/undernet.bundle.min.js" integrity="sha256-rOovHww6Dn9bQcTvKoAwZv/Rys+zd9UJQqb21SqCKaE=" crossorigin="anonymous"></script>
+<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/undernet@2.4.1/dist/undernet.bundle.min.js" integrity="sha256-1QnHhJ6tkW1PuBOTUeAPdrzYxcRceAvqJTi4mHxGmZg=" crossorigin="anonymous"></script>
 <script type="text/javascript">
   document.addEventListener('DOMContentLoaded', Undernet.start())
 </script>