fracty - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "fracty",
-  "version": "1.0.2",
-  "description": "Fracty is a decimal-to-fraction conversion module that solves the many well known problems decimal-to-fraction conversion libraries have. Those common problems include conversion inaccuracies in the IEEE Standard for Float-Point Arithmetic (IEEE 754), mishandling numbers with trailing repeat patterns, and incorrect pattern recognition. Fracty simply takes one argument, a number without any rounding and, in keeping with the most standard numbering conventions of monetary divisibility, etc., imagines that any trailing repeating pattern beyond two decimal places continues infinitely, and returns that input as a string of the fully reduced fraction equivalent.",
+  "version": "1.0.3",
+  "description": "Fracty is a decimal-to-fraction conversion module that solves the many well known problems with decimal-to-fraction conversion modules. Those common problems include overlooking conversion inaccuracies in the IEEE Standard for Float-Point Arithmetic (IEEE 754), mishandling numbers with trailing repeat patterns, and incorrect or partial pattern recognition. Fracty simply takes one argument, a number without any rounding and, in keeping with the most standard numbering conventions of monetary divisibility, etc., imagines that any trailing repeating patterns beyond two decimal places continue infinitely, and returns that input as a string of the fully reduced fraction equivalent.",
   "main": "fracty.js",
@@ -6,0 +6,0 @@ "scripts": {

readme.md

@@ -1,3 +0,74 @@
-# Fracty
+# fracty
 
-Fracty is a decimal-to-fraction conversion module that solves the many well known problems decimal-to-fraction conversion libraries have. Those common problems include conversion inaccuracies in the IEEE Standard for Float-Point Arithmetic (IEEE 754), mishandling numbers with trailing repeat patterns, and incorrect pattern recognition. Fracty simply takes one argument, a number without any rounding and, in keeping with the most standard numbering conventions of monetary divisibility, etc., imagines that any trailing repeating pattern beyond two decimal places continues infinitely, and returns that input as a string of the fully reduced fraction equivalent.
+Fracty is a decimal-to-fraction conversion module that solves the many well known problems with decimal-to-fraction conversion modules. Those common problems include overlooking conversion inaccuracies in the IEEE Standard for Float-Point Arithmetic (IEEE 754), mishandling numbers with trailing repeat patterns, and incorrect or partial pattern recognition.
+
+## API
+
+### fracty(number)
+
+```js
+var fracty = require('fracty');
+
+console.log(fracty(6.9024390243902));
+```
+
+Output will be:
+
+```
+6 37/41
+```
+
+```js
+console.log(fracty(4.285714285714)));
+```
+
+Output will be:
+
+```
+4 2/7
+```
+
+```js
+console.log(fracty(-1.1425))));
+```
+
+Output will be:
+
+```
+-1 57/400
+```
+
+## Notes
+
+Fracty simply takes one argument, a number without any rounding and, in keeping with the most standard numbering conventions of monetary divisibility, etc., imagines that any trailing repeating patterns beyond two decimal places continue infinitely, and returns that input as a string of the fully reduced fraction equivalent.
+
+## Installation
+
+With [npm](http://npmjs.org) do
+
+```bash
+$ npm install fracty
+```
+## License
+
+(MIT)
+
+Copyright (c) 2018 David H. <[e-mail]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

No alert changes

Improved metrics

Total package byte prevSize

18331

increased by9.16%

Number of lines in readme file

75

increased by1775%

No dependency changes