fine-uploader - npm Package Compare versions

Comparing version 5.10.1 to 5.11.0

package.json

@@ -5,3 +5,3 @@ {
   "main": "lib/traditional.js",
-  "version": "5.10.1",
+  "version": "5.11.0",
   "description": "Multiple file upload plugin with progress-bar, drag-and-drop, direct-to-S3 & Azure uploading, client-side image scaling, preview generation, form support, chunking, auto-resume, and tons of other features.",
@@ -39,2 +39,8 @@ "keywords": [
   "author": "Widen Enterprises, Inc.",
+  "contributors": [
+    {
+      "name": "Ray Nicholus",
+      "url": "http://raynicholus.com"
+    }
+  ],
   "license": "MIT",
@@ -44,5 +50,20 @@ "bugs": {
   },
-  "engines": {
-    "node": "0.10.33"
+  "devDependencies": {
+    "clean-css": "3.4.19",
+    "jscs": "3.0.7",
+    "jshint": "2.9.2",
+    "karma": "1.1.2",
+    "karma-firefox-launcher": "1.0.0",
+    "karma-mocha": "1.1.1",
+    "karma-spec-reporter": "0.0.26",
+    "mocha": "3.0.1",
+    "node-static": "0.7.8 ",
+    "pica": "latest",
+    "uglify-js": "2.7.0"
+  },
+  "scripts": {
+    "build": "make clean; make build-all-ui",
+    "lint": "make lint",
+    "test": "make lint && make test"
   }
-}
+}

README.md

@@ -33,13 +33,3 @@ [![Fine Uploader](http://fineuploader.com/img/FineUploader_logo.png)](http://fineuploader.com/)
 
-### Contribute code
 
-The best way to contribute code is to open up a pull request that addresses one of the open [feature requests or bugs][issues]. In order to get started developing Fine Uploader, follow these steps to get the project up and running on your local development machine:
-
-1. Download the project repository: `git clone https://github.com/FineUploader/fine-uploader.git`.
-2. Install all project development dependencies: `npm install`.
-3. To run the tests & linter: `$(npm bin)/grunt dev test:firefox` (you'll need Firefox installed locally).
-4. Please follow the [Angular.js commit guidelines][angular-commit].
-5. Please follow the [Git Flow][git-flow] branching strategy.
-
-
 ### File a bug report
@@ -65,2 +55,31 @@
 
+### Contribute code
+
+The best way to contribute code is to open up a pull request that addresses one of the open [feature requests or bugs][issues]. In order to get started developing Fine Uploader, read this entire section to get the project up and running on your local development machine. This section describes how you can build and test Fine Uploader locally. You may use these instructions to build a copy for yourself, or to contribute changes back to the library. 
+
+#### Setup
+
+You must have Node.js instaled locally (any version should be fine), _and_ you must have Unix-like environment to work with. Linux, FreeBSD/OS X, Cygwin, and Windows 10 bash all _should_ be acceptable environments. Please open up a new issue if you have trouble building. The build process is centered around a single Makefile, so GNU Make is required as well (though most if not all Unix-like OSes should already have this installed). Finally, you will need a git client.
+
+To pull down the project & build dependencies:
+
+1. Download the project repository: `git clone https://github.com/FineUploader/fine-uploader.git`.
+2. Install all project development dependencies: `npm install`.
+
+#### Generating build artifacts
+
+- To build all build artifacts for all endpoint types: `make build`. You can speed this process up a bit by using the parallel recipes feature of Make: `make build -j`. If you would like to build only a specific endpoint type, see the Makefile for the appropriate recipe. The build output will be created in the `_build` directory. 
+- To build zip files for all endpoint types: `make zip`. To build a zip for only a specific endpoint type, see the Makefile for the appropriate recipe. The zip files will be included alongside the build output in the `_build` directory.
+- To rev the version number: `make rev-version target=NEW_VERSION`, where `NEW_VERSION` is the semver-compatible target version identifier.
+
+#### Running tests
+
+To build, run the tests & linter: `npm test` (you'll need Firefox installed locally).
+
+#### Commiting new code and changes
+
+- Follow the [Angular.js commit guidelines][angular-commit].
+- Follow the [Git Flow][git-flow] branching strategy.
+
+
 *Fine Uploader is a code library sponsored by [Widen Enterprises, Inc.](http://www.widen.com/)*
@@ -67,0 +86,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21064802

increased by309.74%

Number of package files

206

increased by15.08%

Lines of code

95284

increased by2.01%

Number of lines in readme file

88

increased by27.54%

Worsened metrics

Dev dependency count

11

increased byInfinity%

No dependency changes