Merge pull request #20 from openimis/feature/OM-110

OM-110: improve docs

README.md

@@ -1,4 +1,5 @@
 # openIMIS Frontend Worker Voucher module
+
 This repository holds the files of the openIMIS Frontend Worker Voucher module.
 It is dedicated to be bootstrap development of [openimis-fe_js](https://github.com/openimis/openimis-fe_js) modules, providing an empty (yet deployable) module.
 
@@ -12,18 +13,43 @@ In development mode, you can use `npm link` and `npm start` to continuously scan
 
 ## Main Menu Contributions
 
-**Workers and Vouchers** ('worker.MainMenu') - it is displayed if __"isWorker"__ variable is set to __true__.
+__Workers and Vouchers__ ('worker.MainMenu') - it is displayed if __"isWorker"__ variable is set to __true__.
+    **Workers** ('menu.workers') - workers list, it is displayed if __"isWorker"__ variable is set to __true__.
+    **Voucher List** ('menu.voucherList') - vouchers list, it is displayed if user has `204001` right
+    **Voucher Acquirement** ('menu.voucherAcquirement') - voucher acquirement form, it is displayed if user has `204001` right
+    **Voucher Assignment** ('menu.voucherAssignment') - voucher assignment form, it is displayed if user has `204001` right
+
+__Administration__ ('admin.mainMenu') - it is displayed by default, main entry of admin module
+    **Voucher Price Management** ('menu.priceManagement') - voucher price management page, it is displayed if user has `205001` right
 
 ## Other Contributions
 
-* `core.Router`: registering `voucher/vouchers`, `voucher/vouchers/voucher`, `voucher/acquirement`, `voucher/assignment`, routes in openIMIS client-side router
+* `core.Router`: registering `voucher/vouchers`, `voucher/vouchers/voucher`, `voucher/acquirement`, `voucher/assignment`, `voucher/price` routes in openIMIS client-side router
 
 ## Available Contribution Points
 
+--- None ---
+
 ## Dispatched Redux Actions
 
+* `WORKER_VOUCHER_MUTATION`, mutates and changes the state of worker voucher
+* `WORKER_VOUCHER_ACQUIRE_GENERIC_VOUCHER`, handles the process of acquiring a generic voucher for worker
+* `WORKER_VOUCHER_ACQUIRE_SPECIFIC_VOUCHER`, handles the process of acquiring a specific voucher for worker
+* `WORKER_VOUCHER_ASSIGN_VOUCHERS`, handles the assignment of one or more vouchers to workers
+* `WORKER_VOUCHER_WORKER_VOUCHERS`, fetches all worker vouchers associated with a particular employer
+* `WORKER_VOUCHER_GET_WORKER_VOUCHER`, fetches information about a specific worker voucher
+* `WORKER_VOUCHER_VOUCHER_PRICES`, fetches the voucher prices
+* `WORKER_VOUCHER_MANAGE_VOUCHER_PRICE`, manages and updates the price of worker vouchers for specific time period
+* `WORKER_VOUCHER_DELETE_VOUCHER_PRICE`, deletes the price of a worker voucher within the context of a specific time frame
+
 ## Other Modules Listened Redux Actions
 
+--- None ---
+
 ## Other Modules Redux State Bindings
 
+* `state.core.user`, to access user info (rights,...)
+
 ## Configurations Options
+
+- `isWorker`: Specifies whether the individual should be classified and managed as a worker or a standard insuree. In Moldova, the Insuree entity is also used to represent workers. When set to true, the system displays 'Workers and Vouchers' instead of the default 'Insurees and Policies', aligning the interface with the specific needs of worker representation. Default: __false__.