add a build step, add comments, rename component.json to bower.json, …

…bump to version 0.2.1

.gitignore

@@ -0,0 +1,2 @@
+# npm
+node_modules/

Gruntfile.js

@@ -0,0 +1,21 @@
+module.exports = function (grunt) {
+  'use strict';
+
+  grunt.initConfig({
+    uglify: {
+      'default': {
+        options: {
+          preserveComments: 'some',
+          sourceMap: 'circular-progress.min.map'
+        },
+        files: {
+          'circular-progress.min.js': 'circular-progress.js'
+        }
+      }
+    }
+  });
+
+  grunt.loadNpmTasks('grunt-contrib-uglify');
+
+  grunt.registerTask('default', ['uglify']);
+};

bower.json

@@ -0,0 +1,14 @@
+{
+  "name": "circular-progress",
+  "description": "A JavaScript circular progress widget, dependency-free and configurable.",
+  "author": "Bergé Greg <[email protected]>",
+  "version": "0.2.1",
+  "main": "circular-progress.js",
+  "ignore": [
+    ".gitignore",
+    ".jshintrc",
+    "Gruntfile.js",
+    "package.json",
+    "test"
+  ],
+}

circular-progress.js

@@ -1,13 +1,15 @@
+/*! circular-progress - v0.2.1 - https://github.com/neoziro/circular-progress */
+
 (function () {
-  var autoscale, extendCtx, ctxProperties, CircularProgress;
 
-  ctxProperties = ['fillStyle', 'font', 'globalAlpha', 'globalCompositeOperation',
+  // List of 2D context properties
+  var ctxProperties = ['fillStyle', 'font', 'globalAlpha', 'globalCompositeOperation',
         'lineCap', 'lineDashOffset', 'lineJoin', 'lineWidth',
         'miterLimit', 'shadowBlur', 'shadowColor', 'shadowOffsetX',
         'shadowOffsetY', 'strokeStyle', 'textAlign', 'textBaseLine'];
 
-  // autoscale function from https://github.com/component/autoscale-canvas
-  autoscale = function (canvas) {
+  // Autoscale function from https://github.com/component/autoscale-canvas
+  var autoscale = function (canvas) {
     var ctx = canvas.getContext('2d'),
     ratio = window.devicePixelRatio || 1;
 
@@ -22,15 +24,17 @@
     return canvas;
   };
 
-  extendCtx = function (ctx, options) {
+  // Utility function to extend a 2D context with some options
+  var extendCtx = function (ctx, options) {
     for (var i in options) {
       if (ctxProperties.indexOf(i) === -1) continue;
 
       ctx[i] = options[i];
     }
   };
 
-  CircularProgress = this.CircularProgress = function (options) {
+  // Main CircularProgress object exposes on global context
+  var CircularProgress = this.CircularProgress = function (options) {
     var ctx, i, property;
 
     options = options || {};
@@ -51,12 +55,14 @@
     if (options.radius) this.radius(options.radius);
   };
 
+  // Update with a new `percent` value and redraw the canvas
   CircularProgress.prototype.update = function (value) {
     this._percent = value;
     this.draw();
     return this;
   };
 
+  // Specify a new `radius` for the circle
   CircularProgress.prototype.radius = function (value) {
     var size = value * 2;
     this.el.width = size;
@@ -65,6 +71,7 @@
     return this;
   };
 
+  // Draw the canvas
   CircularProgress.prototype.draw = function () {
     var tw, text, fontSize,
         options = this.options,
@@ -79,7 +86,7 @@
 
     ctx.clearRect(0, 0, size, size);
 
-    // initial circle
+    // Initial circle
     if (options.initial) {
       extendCtx(ctx, options);
       extendCtx(ctx, options.initial);
@@ -89,14 +96,14 @@
       ctx.stroke();
     }
 
-    // progress circle
+    // Progress circle
     extendCtx(ctx, options);
 
     ctx.beginPath();
     ctx.arc(x, y, half - ctx.lineWidth, 0, angle, false);
     ctx.stroke();
 
-    // text
+    // Text
     if (options.text) {
       extendCtx(ctx, options);
       extendCtx(ctx, options.text);

package.json

@@ -0,0 +1,10 @@
+{
+  "name": "circular-progress",
+  "description": "A JavaScript circular progress widget, dependency-free and configurable.",
+  "author": "Bergé Greg <[email protected]>",
+  "version": "0.2.1",
+  "devDependencies": {
+    "grunt": "~0.4.1",
+    "grunt-contrib-uglify": "~0.2.0"
+  }
+}