Update Readme and misc configs

README.md

@@ -1,34 +1,35 @@
-# dhis2-downloader
+# DHIS2 Data Downloader
 
-An Electron application with React
+## Introduction
 
-## Recommended IDE Setup
+The DHIS2 (District Health Information Software 2) Data Downloader is a React-based Electron application that allows users to connect to a DHIS2 instance, select
 
-- [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+### Features
 
-## Project Setup
+- Main - Allows downloading HMIS data with selected date range, data elements, organization levels, organization units, and disaggregated dimensions (supporting chunked downloads with an increased speed than the Colab API)
 
-### Install
+- **HMIS Data Dictionary**: The downloader allows users to search the relevant terms and get the 11-letter JSON ID for Data Elements, Indicators, and Category Combos. Additionally, it converts the JSON IDs to readable names for Indicators when the numerator and denominator are available.
 
-```bash
-$ npm install
-```
+- **Record Downloading History**: The downloader can record the successful downloading requests and re-download requests during the login session.
 
-### Development
+## Build on Your Desktop
 
 ```bash
-$ npm run dev
-```
+$ git clone https://github.com/ccxzhang/dhis2-downloader.git
+$ cd dhis2-downloader
+$ npm install
 
-### Build
+# Start the app
+$ npm run start
 
-```bash
 # For windows
 $ npm run build:win
-
 # For macOS
 $ npm run build:mac
-
 # For Linux
 $ npm run build:linux
 ```
+
+## Acknowledgements
+
+We would like to thank Damola Sheriff Olajide with the West African Health Organization who provided the software [prototype](https://github.com/dolajide/dhis2-poc) for the FASTR Data Downloader.

electron-builder.yml

@@ -13,6 +13,7 @@ asarUnpack:
   - resources/**
 win:
   executableName: DHIS2 Downloader
+  icon: resources/icon.png
 nsis:
   artifactName: ${name}-${version}-setup.${ext}
   shortcutName: ${productName}

package.json

@@ -3,8 +3,9 @@
   "version": "0.0.1",
   "description": "DHIS2 Downloader",
   "main": "./out/main/index.js",
-  "author": "example.com",
-  "homepage": "https://electron-vite.org",
+  "author": "globalfinancingfacility.org",
+  "private": true,
+  "homepage": "https://www.globalfinancingfacility.org/results",
   "scripts": {
     "format": "prettier --write .",
     "lint": "eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix",
@@ -14,7 +15,7 @@
     "build": "electron-vite build",
     "postinstall": "electron-builder install-app-deps",
     "build:unpack": "npm run build && electron-builder --dir",
-    "build:win": "npm run build && electron-builder --win",
+    "build:win": "npm run build && electron-builder --win --x64",
     "build:mac": "npm run build && electron-builder --mac",
     "build:linux": "npm run build && electron-builder --linux"
   },