Skip to content

Commit

Permalink
docs: rewrite intial chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
pawel-id committed Dec 31, 2023
1 parent 5593456 commit e82bd1d
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# BIR1 - GUS REGON client

Simple node.js client library to
[Statistics Poland](https://en.wikipedia.org/wiki/Statistics_Poland) (GUS)
information about companies
[api REGON](https://api.stat.gov.pl/Home/RegonApi?lang=en)
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.

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

## Install

Expand Down

0 comments on commit e82bd1d

Please sign in to comment.