bb26 - npm Package Compare versions

Comparing version 2.2.0 to 2.2.1

package.json

 {
   "name": "bb26",
-  "version": "2.2.0",
-  "description": "Bijective base-26 utility functions for converting numbers to/from spreadsheet column letters",
-  "repository": "github:ptrkcsk/BB26",
-  "author": "Patrik Csak <[e-mail]>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/ptrkcsk/BB26/issues"
-  },
-  "homepage": "https://github.com/ptrkcsk/BB26#readme",
+  "version": "2.2.1",
+  "description": "Utilities for working with bijective base-26 numerals",
   "keywords": [
@@ -18,8 +11,16 @@ "base 26",
     "spreadsheet column",
-    "spreadsheet column letters"
+    "spreadsheet column letters",
+    "license plate serials"
   ],
-  "main": "dist",
+  "homepage": "https://github.com/ptrkcsk/BB26#readme",
+  "bugs": {
+    "url": "https://github.com/ptrkcsk/BB26/issues"
+  },
+  "license": "MIT",
+  "author": "Patrik Csak <[e-mail]>",
   "files": [
     "dist"
   ],
+  "main": "dist",
+  "repository": "github:ptrkcsk/BB26",
   "scripts": {
@@ -26,0 +27,0 @@ "build": "tsc",

readme.md

 # BB26
 
-[![Test Coverage](https://api.codeclimate.com/v1/badges/c56701b3968f3de65188/test_coverage)](https://codeclimate.com/github/ptrkcsk/BB26/test_coverage) [![Maintainability](https://api.codeclimate.com/v1/badges/c56701b3968f3de65188/maintainability)](https://codeclimate.com/github/ptrkcsk/BB26/maintainability) [![BB26 minified and gzipped size](https://badgen.net/bundlephobia/minzip/bb26)](https://bundlephobia.com/result?p=bb26)
+[![BB26 minified and gzipped size](https://badgen.net/bundlephobia/minzip/bb26)](https://bundlephobia.com/result?p=bb26) [![BB26 downloads per month on npm](https://badgen.net/npm/dw/bb26)](https://www.npmjs.com/package/bb26) [![Test Coverage](https://api.codeclimate.com/v1/badges/c56701b3968f3de65188/test_coverage)](https://codeclimate.com/github/ptrkcsk/BB26/test_coverage)
 
-JavaScript [bijective base-26](https://en.wikipedia.org/wiki/Bijective_numeration#The_bijective_base-26_system) utility functions for converting numbers to/from spreadsheet column letters
+BB26 is a JavaScript library for working with [bijective base-26](https://en.wikipedia.org/wiki/Bijective_numeration#The_bijective_base-26_system) (BB26) numbers
 
+## What is bijective base-26 numeration?
+
+You're probably familiar with BB26 numeration. It's used for spreadsheet columns, license plate serials, and (probably?) more.
+
+Here's an example of decimal (base-10) numbers (the numbers you use every day to count things) compared to their corresponding BB26 numbers:
+
+```
+Decimal: | 1 | 2 | 3 | ... | 24 | 25 | 26 | 27 | 28 | 29 | ...
+   BB26: | A | B | C | ... |  X |  Y |  Z | AA | AB | AC | ...
+```
+
 ## Installation
@@ -38,3 +49,3 @@
 
-Produces a random string between the inclusive lower and upper bounds. If only one argument is provided, a string between 'A' and the given string is returned.
+Produces a random string between the inclusive `lower` and `upper` bounds. If only one argument is provided, a string between `'A'` and the given string is returned.
 
@@ -55,6 +66,4 @@ ```js
 
-Creates an array of bijective base-26 numerals progressing from start up to, but not including, end.
+Creates an array of bijective base-26 numerals progressing from `start` up to, but not including, `end`. If `end` is not specified, it's set to `start` with `start` then set to `'A'`.
 
-If end is not specified, it's set to start with start then set to 'A'.
-
 ```js
@@ -61,0 +70,0 @@ import { range } from 'bb26'

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

11606

increased by3.33%

Number of lines in readme file

112

increased by8.74%

No dependency changes