From 0e7dd4650439994813120a081c27e4075f88880b Mon Sep 17 00:00:00 2001 From: Pawel Idczak Date: Sun, 25 Feb 2024 23:53:42 +0100 Subject: [PATCH] update readme --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index daebcb1..928d850 100644 --- a/README.md +++ b/README.md @@ -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).