Update docs & fix out-of-sync versions for bower.json and jquery conf…

…ig json
rozalen · Oct 1, 2014 · 9165228 · 9165228
1 parent d34cb80
commit 9165228
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 15 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -87,8 +87,9 @@ module.exports = function(grunt) {
     version: {
       patch: {
         src: [
-          '<%= pluginName %>.jquery.json',
           'package.json',
+          '<%= pluginName %>.jquery.json',
+          'bower.json',
           'src/jquery.<%= pluginName %>.js',
           'jquery.<%= pluginName %>.js'
         ],
@@ -136,7 +137,7 @@ module.exports = function(grunt) {
   grunt.registerTask( 'deploy', ['setshell:rsync', 'shell:rsync']);
 
   grunt.registerTask( 'configs', 'Update json configs based on package.json', function() {
-    var pkg = grunt.config('pkg'),
+    var pkg = grunt.file.readJSON('package.json'),
         pkgBasename = grunt.config('pluginName'),
         bowerFile = grunt.config('bower'),
         bower = grunt.file.readJSON(bowerFile),

diff --git a/bower.json b/bower.json
@@ -1,6 +1,6 @@
 {
   "name": "jquery.smooth-scroll",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "dependencies": {
     "jquery": ">=1.3"
   },

diff --git a/index.html b/index.html
diff --git a/jquery.smooth-scroll.js b/jquery.smooth-scroll.js
@@ -1,12 +1,12 @@
 /*!
- * jQuery Smooth Scroll - v1.5.1 - 2014-10-01
+ * jQuery Smooth Scroll - v1.5.2 - 2014-10-01
  * https://github.com/kswedberg/jquery-smooth-scroll
  * Copyright (c) 2014 Karl Swedberg
  * Licensed MIT (https://github.com/kswedberg/jquery-smooth-scroll/blob/master/LICENSE-MIT)
  */
 
 (function($) {
-var version = '1.5.1',
+var version = '1.5.2',
     optionOverrides = {},
     defaults = {
       exclude: [],

diff --git a/jquery.smooth-scroll.min.js b/jquery.smooth-scroll.min.js
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "jquery-smooth-scroll",
   "title": "jQuery Smooth Scroll",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "scripts": {},
   "main": "jquery.smooth-scroll.js",
   "author": {

diff --git a/readme.md b/readme.md
@@ -1,10 +1,30 @@
 # Smooth Scroll Plugin
 
+Allows for easy implementation of smooth scrolling for same-page links.
+
+## Download
+
+Using npm:
+
+```bash
+npm install jquery-smooth-scroll
+```
+
+Using bower:
+
+```bash
+bower install jquery-smooth-scroll
+```
+
+The old-fashioned way:
+
+Go to the following URL in your browser and copy/paste the code into your own file:
+https://raw.githubusercontent.com/kswedberg/jquery-smooth-scroll/master/jquery.smooth-scroll.js
+
 ## Features
 
 ### $.fn.smoothScroll
 
-* Allows for easy implementation of smooth scrolling for same-page links.
 * Works like this: `$('a').smoothScroll();`
 * Specify a containing element if you want: `$('#container a').smoothScroll();`
 * Exclude links if they are within a containing element: `$('#container a').smoothScroll({excludeWithin: ['.container2']});`

diff --git a/smooth-scroll.jquery.json b/smooth-scroll.jquery.json
@@ -1,6 +1,6 @@
 {
   "name": "smooth-scroll",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "title": "Smooth Scroll",
   "description": "Easy implementation of smooth scrolling for same-page links",
   "author": {

diff --git a/src/jquery.smooth-scroll.js b/src/jquery.smooth-scroll.js
@@ -1,5 +1,5 @@
 (function($) {
-var version = '1.5.1',
+var version = '1.5.2',
     optionOverrides = {},
     defaults = {
       exclude: [],