js-xdr - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

bower.json

 {
-  "name": "xdr",
+  "name": "js-xdr",
   "version": "0.0.1",
@@ -4,0 +4,0 @@ "private": false,

package.json

 {
   "name": "js-xdr",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Read/write XDR encoded data structures (RFC 4506)",
@@ -29,2 +29,3 @@ "main": "lib/index.js",
     "gulp": "^3.8.11",
+    "gulp-babel": "^4.0.1",
     "gulp-coveralls": "^0.1.3",
@@ -34,2 +35,3 @@ "gulp-git": "~0.5.3",
     "gulp-load-plugins": "^0.9.0",
+    "gulp-mocha": "^2.0.1",
     "gulp-plumber": "^1.0.0",
@@ -57,4 +59,2 @@ "gulp-rename": "~1.2.0",
     "cursor": "^0.1.5",
-    "gulp-babel": "^4.0.1",
-    "gulp-mocha": "^2.0.1",
     "lodash": "^3.5.0",
@@ -61,0 +61,0 @@ "long": "^2.2.3",

README.md

@@ -6,5 +6,20 @@ # XDR, for Javascript
 [![Travis build status](http://img.shields.io/travis/stellar/js-xdr.svg?style=flat)](https://travis-ci.org/stellar/js-xdr)
-[![Code Climate](https://codeclimate.com/github/stellar/js-xdr/badges/gpa.svg)](https://codeclimate.com/github/stellar/js-xdr)
-[![Test Coverage](https://codeclimate.com/github/stellar/js-xdr/badges/coverage.svg)](https://codeclimate.com/github/stellar/js-xdr)
 [![Dependency Status](https://david-dm.org/stellar/js-xdr.svg)](https://david-dm.org/stellar/js-xdr)
 [![devDependency Status](https://david-dm.org/stellar/js-xdr/dev-status.svg)](https://david-dm.org/stellar/js-xdr#info=devDependencies)
+
+XDR is an open data format, specified in [RFC 4506](http://tools.ietf.org/html/rfc4506.html).  This library provides a way to read and write XDR data from javascript.  It can read/write all of the primitive XDR types and also provides facilities to define readers for the compound XDR types (enums, structs and unions)
+
+## Caveats
+
+There are a couple of caveats to be aware of with this library:
+
+1.  We do not support quadruple precision floating point values.  Attempting to read or write these values will throw errors.
+2.  NaN is not handled perfectly for floats and doubles.  There are several forms of NaN as defined by IEEE754 and the browser polyfill for node's Buffer class seems to handle them poorly.  
+
+
+## Code generation
+
+js-xdr by itself does not have any ability to parse XDR IDL files and produce a parser for your custom data types.  Instead, that is the responsibility of [xdrgen](http://github.com/stellar/xdrgen).  xdrgen will take your .x files and produce a javascript file that target this library to allow for your own custom types.
+
+See [js-stellar-base](http://github.com/stellar/js-stellar-base) for an example (check out the src/generated directory)
+

No alert changes

Improved metrics

Total package byte prevSize

961816

increased by0.1%

Dependency count

4

decreased by-33.33%

Number of lines in readme file

25

increased by150%

Worsened metrics

Dev dependency count

32

increased by6.67%

Dependency changes

• - Removedgulp-babel@^4.0.1

• - Removedgulp-mocha@^2.0.1

• - Removedacorn@5.7.4(transitive)

• - Removedacorn-babel@0.11.1-38(transitive)

• - Removedamdefine@1.0.1(transitive)

• - Removedansi-gray@0.1.1(transitive)

• - Removedansi-regex@2.1.1(transitive)

• - Removedansi-styles@2.2.1(transitive)

• - Removedansi-wrap@0.1.0(transitive)

• - Removedarray-differ@1.0.0(transitive)

• - Removedarray-uniq@1.0.3(transitive)

• - Removedast-types@0.7.80.8.150.9.6(transitive)

• - Removedbabel-core@4.7.16(transitive)

• - Removedbalanced-match@1.0.2(transitive)

• - Removedbeeper@1.1.1(transitive)

• - Removedbrace-expansion@1.1.11(transitive)

• - Removedchalk@1.1.3(transitive)

• - Removedclone@1.0.4(transitive)

• - Removedclone-stats@0.0.1(transitive)

• - Removedcolor-support@1.1.3(transitive)

• - Removedcommander@0.6.12.20.32.3.0(transitive)

• - Removedcommoner@0.10.8(transitive)

• - Removedconcat-map@0.0.1(transitive)

• - Removedconvert-source-map@0.5.1(transitive)

• - Removedcore-js@0.6.1(transitive)

• - Removedcore-util-is@1.0.3(transitive)

• - Removeddateformat@2.2.0(transitive)

• - Removeddebug@2.2.02.6.9(transitive)

• - Removeddefined@1.0.1(transitive)

• - Removeddetect-indent@3.0.1(transitive)

• - Removeddetective@4.7.1(transitive)

• - Removeddiff@1.4.0(transitive)

• - Removedduplexer2@0.0.2(transitive)

• - Removedescape-string-regexp@1.0.21.0.5(transitive)

• - Removedesprima@2.7.33.1.3(transitive)

• - Removedesprima-fb@15001.1001.0-dev-harmony-fb(transitive)

• - Removedestraverse@1.9.3(transitive)

• - Removedesutils@1.1.6(transitive)

• - Removedfancy-log@1.3.3(transitive)

• - Removedfs-readdir-recursive@0.1.2(transitive)

• - Removedfs.realpath@1.0.0(transitive)

• - Removedget-stdin@4.0.1(transitive)

• - Removedglob@3.2.115.0.157.2.3(transitive)

• - Removedglobals@6.4.1(transitive)

• - Removedglogg@1.0.2(transitive)

• - Removedgraceful-fs@4.2.11(transitive)

• - Removedgrowl@1.9.2(transitive)

• - Removedgulp-babel@4.0.1(transitive)

• - Removedgulp-mocha@2.2.0(transitive)

• - Removedgulp-util@3.0.8(transitive)

• - Removedgulplog@1.0.0(transitive)

• - Removedhas-ansi@2.0.0(transitive)

• - Removedhas-gulplog@0.1.0(transitive)

• - Removediconv-lite@0.4.24(transitive)

• - Removedinflight@1.0.6(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedirregular-plurals@1.4.0(transitive)

• - Removedis-finite@1.1.0(transitive)

• - Removedis-integer@1.0.7(transitive)

• - Removedisarray@0.0.11.0.0(transitive)

• - Removedjade@0.26.3(transitive)

• - Removedjs-tokens@1.0.0(transitive)

• - Removedjsesc@0.5.0(transitive)

• - Removedleft-pad@0.0.3(transitive)

• - Removedleven@1.0.2(transitive)

• - Removedline-numbers@0.2.0(transitive)

• - Removedlodash._basecopy@3.0.1(transitive)

• - Removedlodash._basetostring@3.0.1(transitive)

• - Removedlodash._basevalues@3.0.0(transitive)

• - Removedlodash._getnative@3.9.1(transitive)

• - Removedlodash._isiterateecall@3.0.9(transitive)

• - Removedlodash._reescape@3.0.0(transitive)

• - Removedlodash._reevaluate@3.0.0(transitive)

• - Removedlodash._reinterpolate@3.0.0(transitive)

• - Removedlodash._root@3.0.1(transitive)

• - Removedlodash.escape@3.2.0(transitive)

• - Removedlodash.isarguments@3.1.0(transitive)

• - Removedlodash.isarray@3.0.4(transitive)

• - Removedlodash.keys@3.1.2(transitive)

• - Removedlodash.restparam@3.6.1(transitive)

• - Removedlodash.template@3.6.2(transitive)

• - Removedlodash.templatesettings@3.1.1(transitive)

• - Removedlru-cache@2.7.3(transitive)

• - Removedminimatch@0.3.03.1.2(transitive)

• - Removedminimist@0.0.81.2.8(transitive)

• - Removedmkdirp@0.3.00.5.1(transitive)

• - Removedmocha@2.5.3(transitive)

• - Removedms@0.7.12.0.0(transitive)

• - Removedmultipipe@0.1.2(transitive)

• - Removedobject-assign@2.1.13.0.04.1.1(transitive)

• - Removedonce@1.4.0(transitive)

• - Removedoutput-file-sync@1.1.2(transitive)

• - Removedparse-node-version@1.0.1(transitive)

• - Removedpath-is-absolute@1.0.1(transitive)

• - Removedplur@2.1.2(transitive)

• - Removedprivate@0.1.8(transitive)

• - Removedprocess-nextick-args@2.0.1(transitive)

• - Removedq@1.5.1(transitive)

• - Removedreadable-stream@1.0.341.1.142.3.8(transitive)

• - Removedrecast@0.10.430.11.23(transitive)

• - Removedregenerate@1.4.2(transitive)

• - Removedregenerator-babel@0.8.13-2(transitive)

• - Removedregexpu@1.3.0(transitive)

• - Removedregjsgen@0.2.0(transitive)

• - Removedregjsparser@0.1.5(transitive)

• - Removedrepeating@1.1.3(transitive)

• - Removedreplace-ext@0.0.1(transitive)

• - Removedresolve-from@1.0.1(transitive)

• - Removedrimraf@2.6.3(transitive)

• - Removedsafe-buffer@5.1.2(transitive)

• - Removedsafer-buffer@2.1.2(transitive)

• - Removedshebang-regex@1.0.0(transitive)

• - Removedsigmund@1.0.1(transitive)

• - Removedslash@1.0.0(transitive)

• - Removedsource-map@0.1.320.1.430.4.40.5.7(transitive)

• - Removedsource-map-support@0.2.10(transitive)

• - Removedsparkles@1.0.1(transitive)

• - Removedstring_decoder@0.10.311.1.1(transitive)

• - Removedstrip-ansi@3.0.1(transitive)

• - Removedsupports-color@1.2.02.0.0(transitive)

• - Removedtemp@0.8.4(transitive)

• - Removedthrough@2.3.8(transitive)

• - Removedthrough2@0.6.52.0.5(transitive)

• - Removedtime-stamp@1.1.0(transitive)

• - Removedto-fast-properties@1.0.3(transitive)

• - Removedto-iso-string@0.0.2(transitive)

• - Removedtrim-right@1.0.1(transitive)

• - Removedutil-deprecate@1.0.2(transitive)

• - Removedvinyl@0.5.3(transitive)

• - Removedvinyl-sourcemaps-apply@0.1.4(transitive)

• - Removedwrappy@1.0.2(transitive)

• - Removedxtend@4.0.2(transitive)