From 8aa25bea4798b8951e4ef1bc3bd153bae275083f Mon Sep 17 00:00:00 2001
From: Harsh Verma <55652117+Harsh3305@users.noreply.github.com>
Date: Thu, 29 Jun 2023 22:22:11 +0530
Subject: [PATCH] Create README.md (#15)

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4ea36ea
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# order-library
+[![Build Flow](https://github.com/HRV-Mart/order-library/actions/workflows/build.yml/badge.svg)](https://github.com/HRV-Mart/order-library/actions/workflows/build.yml)
+![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/HRV-Mart/order-library)
+
+`order-library` package created for HRV-Mart to help Spring boot application to get data from order backend.
+## How to use
+1) Define dependency in `build.gradle` or `build.gradle.kts` or `pom.xml`
+   Use [this link](https://github.com/orgs/HRV-Mart/packages?repo_name=order-library) to pick appropriate version.
+2) Authenticate with GitHub Package. [link](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#authenticating-with-a-personal-access-token)
+3) Build your project