Added the project how to use example

CHANGELOG.md

@@ -0,0 +1,20 @@
+
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased] - yyyy-mm-dd
+
+Here we write upgrading notes for brands. It's a team effort to make them as
+straightforward as possible.
+
+## [1.0.0] - 2023-03-04
+
+### Added
+- Added the initial project structure
+- Added the functionality to fetch the list of the counties
+- Added the example on how to use
+
+### Changed

example/example.ts

@@ -0,0 +1,3 @@
+import processCounties from "../lib/index"
+
+console.info("----", JSON.stringify(processCounties))

lib/index.ts

@@ -5,7 +5,7 @@ import constants from "./constants"
 
 const queue = fastq.promise(worker, constants.WORKER_CONCURRENCY)
 
-async function worker() {
+async function processCounties() {
   const targetUrl = constants.KENYA_COUNTIES_URL;
   const pageResponse = await axios.get(targetUrl);
   const $ = cheerio.load(pageResponse.data);
@@ -31,11 +31,18 @@ async function worker() {
   return result
 }
 
+async function worker() {
+  let resultSet = await processCounties()
+  return resultSet
+}
+
 async function run() {
   let result = await queue.push({})
-  console.info(JSON.stringify(result))
+  return result
 }
 
 run().catch(e => {
   console.error(e)
-})
+})
+
+export default { processCounties }

package.json

@@ -1,6 +1,9 @@
 {
+  "name": "counties-kenya-lib",
+  "version": "1.0.0",
   "scripts": {
-    "dev": "esr ./lib/index.ts"
+    "dev": "esr ./lib/index.ts",
+    "example": "esr ./example/example.ts"
   },
   "dependencies": {
     "axios": "^1.3.4",
@@ -12,4 +15,4 @@
     "esbuild-runner": "^2.2.2",
     "typescript": "^4.9.5"
   }
-}
+}