From b7b3551ce2106b97ec27b9071e999779758fbe6f Mon Sep 17 00:00:00 2001
From: khavinshankar <khavinshankar@gmail.com>
Date: Mon, 25 Sep 2023 21:55:53 +0530
Subject: [PATCH] updated readme

---
 README.md    | 37 ++++++++++++++++---------------------
 package.json |  6 +++++-
 2 files changed, 21 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
index 1ebe379..f20b179 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,22 @@
-# React + TypeScript + Vite
+# HI Profiles
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+**This package provides react components for the [ABDM FHIR profiles](https://nrces.in/ndhm/fhir/r4/index.html).**
 
-Currently, two official plugins are available:
+### Installation
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+```sh
+npm install hi-profiles
+```
 
-- Configure the top-level `parserOptions` property like this:
+### Usage
 
 ```js
-   parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
-    tsconfigRootDir: __dirname,
-   },
-```
-
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+import { HIProfile } from "hi-profiles";
+import fhirBundle from "..."; // sample abdm fhir bundles can be found at https://sandbox.abdm.gov.in/abdm-docs/DiagnosticReports
+
+export default function App() {
+   return (
+      <HIProfile bundle={fhirBundle} />
+   )
+}
+```
\ No newline at end of file
diff --git a/package.json b/package.json
index a241cfa..2e02aaf 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "hi-profiles",
   "private": false,
-  "version": "1.0.4",
+  "version": "1.0.5",
   "type": "module",
   "main": "dist/index.umd.js",
   "module": "dist/index.es.js",
@@ -14,6 +14,10 @@
     "abdm",
     "abdm m3"
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/coronasafe/hi-profiles"
+  },
   "exports": {
     ".": {
       "import": "./dist/index.es.js",