From 9dba322acffaa386dd8cd3dd2679ca878ba37ea4 Mon Sep 17 00:00:00 2001 From: Pawel Idczak Date: Tue, 27 Feb 2024 21:30:28 +0100 Subject: [PATCH] update readme --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8b54bc4..7bc6bca 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,18 @@ Simple node.js client library to provide information about authorized government administration authorities, regional authorities, government institutions and to commercial entities. It connects to [REGON service](https://api.stat.gov.pl/Home/RegonApi?lang=en) and returns data -in JSON format. Supports all BIR 1.0 and 1.1 API methods. Please refer to link -above to find documentation for more details. +in JSON format. Data returned data from SOAP messages are parsed to JSON. By +default the following rules apply: -BIR1 (polish: "Baza Internetowa REGON") is an internal name of the API service -(hence our package name). +- keys are left intact (GUS use mix of snake_case and camelCase) +- values are converted to strings. Empty values are left as empty strings + +Why BIR1 was choosen as package name? BIR1 (polish: "Baza Internetowa REGON") is +an internal name of the API service maintained by GUS. Implementation follows best practices of modern node.js. It is ESM module written in TypeScript with carefully crafted type definitions. Enjoy! -Data returned data from SOAP messages are parsed to JSON. By default the -following rules apply: - -- keys are left intact (it is mixed snake_case and camelCase) -- values are converted to strings. Empty values are left as empty strings - ## Install ```bash @@ -47,7 +44,7 @@ console.log(await bir.search({ nip: '5261040567' })) // } ``` -see more examples in [examples](./examples) directory +See more examples [here](./examples). ## API