From e82bd1dc067df4ee9de2eabd10a4c30511cb9b63 Mon Sep 17 00:00:00 2001 From: Pawel Idczak Date: Sun, 31 Dec 2023 12:12:52 +0100 Subject: [PATCH] docs: rewrite intial chapter --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7d34308..4d80222 100644 --- a/README.md +++ b/README.md @@ -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