@furkot/address - npm Package Compare versions

Comparing version 0.0.0 to 0.0.1

index.js

@@ -1,1 +0,1 @@
-module.exports = require('./lib/address');
+module.exports = require('./lib');

package.json

 {
   "name": "@furkot/address",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Furkot address normalizer.",
@@ -5,0 +5,0 @@ "author": {

Readme.md

@@ -18,5 +18,30 @@ [![NPM version][npm-image]][npm-url]
 ```js
-var furkotAddress = require('@furkot/address');
+const {
+  normalize,
+  stringify,
+  parse,
+  prettify
+} = require('@furkot/address');
 
-furkotAddress('Rainbow');
+normalize('123 Main St, Los Angeles, California'); // => '123 Main St,Los Angeles,CA,US'
+
+stringify({
+  house: 123,
+  street: 'Main St',
+  city: 'Los Angeles',
+  state: 'California',
+  country: 'USA'
+}); // => '123 Main St,Los Angeles,CA,US'
+
+parse('123 Main St,Los Angeles,CA,US'); // =>
+// { house: 123,
+//   street: 'Main St',
+//   city: 'Los Angeles',
+//   state: 'CA',
+//   country: 'USA'
+// }; 
+
+prettify(',Los Angeles,CA,US'); // => 'Los Angeles, CA'
+prettify('123 Main St,Toronto,ON,CA'); // => '123 Main St, Toronto, ON, Canada'
+prettify('1 Via Toselli,Taranto,Taranto,IT'); // => '1 Via Toselli, Taranto, Italy
 ```
@@ -31,6 +56,6 @@
 
-[build-url]: https://github.com/furkot/@furkot/address/actions/workflows/check.yaml
-[build-image]: https://img.shields.io/github/workflow/status/furkot/@furkot/address/check
+[build-url]: https://github.com/furkot/address/actions/workflows/check.yaml
+[build-image]: https://img.shields.io/github/workflow/status/furkot/address/check
 
 [deps-image]: https://img.shields.io/librariesio/release/npm/@furkot/address
-[deps-url]: https://libraries.io/npm/@furkot/address
+[deps-url]: https://libraries.io/npm/@furkot%2Faddress

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

15226

increased by993.04%

Number of package files

15

increased by275%

Lines of code

575

increased by14275%

Number of lines in readme file

60

increased by71.43%

No dependency changes