Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pawel-id committed Feb 27, 2024
1 parent 5e5146a commit 9dba322
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -47,7 +44,7 @@ console.log(await bir.search({ nip: '5261040567' }))
// }
```

see more examples in [examples](./examples) directory
See more examples [here](./examples).

## API

Expand Down

0 comments on commit 9dba322

Please sign in to comment.