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 25, 2024
1 parent f9eddd5 commit 0e7dd46
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# BIR1 - GUS REGON client

Simple node.js client library to provide information about companies. 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.
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.

BIR1 (polish: "Baza Internetowa REGON") is an internal name of the API service
(hence our package name).
Expand Down

0 comments on commit 0e7dd46

Please sign in to comment.