From 9b85061f5a652b555cd5b198cb84d23e4a84fbf6 Mon Sep 17 00:00:00 2001
From: MAKOBA REAGAN PATRICK <47450907+reagan-meant@users.noreply.github.com>
Date: Mon, 7 Oct 2024 10:57:31 +0300
Subject: [PATCH] Update README.md

---
 README.md | 54 ++++++++++++++++++++----------------------------------
 1 file changed, 20 insertions(+), 34 deletions(-)

diff --git a/README.md b/README.md
index f0d7581..676b437 100644
--- a/README.md
+++ b/README.md
@@ -1,46 +1,32 @@
-![Node.js CI](https://github.com/openmrs/openmrs-esm-template-app/workflows/Node.js%20CI/badge.svg)
+# OpenMRS 3.x IPS ESM
 
-# OpenMRS ESM Template App
+A frontend module for downloading and viewing International Patient Summaries (IPS) in O3.
 
-This repository provides a starting point for creating your own
-[OpenMRS Microfrontend](https://wiki.openmrs.org/display/projects/OpenMRS+3.0%3A+A+Frontend+Framework+that+enables+collaboration+and+better+User+Experience).
+The IPS can be viewed in the patient chart when you navigate to the Patient summary page.
 
-For more information, please see the
-[OpenMRS Frontend Developer Documentation](https://o3-docs.openmrs.org/#/).
-
-In particular, the [Setup](https://o3-docs.openmrs.org/docs/frontend-modules/setup) section can help you get started developing microfrontends in general. The [Creating a microfrontend](https://o3-docs.openmrs.org/docs/recipes/create-a-frontend-module) section provides information about how to use this repository to create your own microfrontend.
-
-## Running this code
+## Getting Started for developers
 
 ```sh
-yarn  # to install dependencies
-yarn start  # to run the dev server
-```
+# Clone the repository
+git clone git@github.com:openmrs/openmrs-esm-ips.git
 
-Once it is running, a browser window
-should open with the OpenMRS 3 application. Log in and then navigate to `/openmrs/spa/root`.
+# to install dependencies
+yarn
 
-## Adapting the code
+# to run the dev server
+yarn start
 
-1. Start by finding and replacing all instances of "template" with the name
-  of your microfrontend.
-2. Update `index.ts` as appropriate, at least changing the feature name and the page name and route.
-3. Rename the `root.*` family of files to have the name of your first page.
-4. Delete the contents of the objects in `config-schema`. Start filling them back in once you have a clear idea what will need to be configured.
-5. Delete the `greeter` and `patient-getter` directories, and the contents of `root.component.tsx`.
-6. Delete the contents of `translations/en.json`.
-7. Open up `.github/workflows` and adapt it to your needs. If you're writing
- a microfrontend that will be managed by the community, you might be able to
-  just replace all instances of `template` with your microfrontend's name.
-  However, if you're writing a microfrontend for a specific organization or
-  implementation, you will probably need to configure GitHub Actions differently.
-8. Delete the contents of this README and write a short explanation of what
-  you intend to build. Links to planning or design documents can be very helpful.
+# OR to start on a specified port eg 5000
+yarn start --port 5000
+```
 
-At this point, you should be able to write your first page as a React application.
+Once it is running, a browser window should open with O3 running. Log in and then navigate to the patient chart under the Patient Summary.
 
-Check out the [Medication dispensing app](https://github.com/openmrs/openmrs-esm-dispensing-app) for an example of a non-trivial app built using the Template.
+## Running tests
 
-## Integrating it into your application
+```sh
+yarn run test
+```
 
-Please see [Creating a Frontend Module](https://o3-docs.openmrs.org/docs/recipes/create-a-frontend-module).
+# Dependencies
+This esm depends on this backend module [See [here](https://github.com/I-TECH-UW/openmrs-module-ips)]