From 252fd9b30a2099315dc1e47ad49916495be6f496 Mon Sep 17 00:00:00 2001
From: Yash raj chhabra <95337653+ychhabra-eightfold@users.noreply.github.com>
Date: Wed, 20 Apr 2022 20:51:54 +0530
Subject: [PATCH] chore: update readme with usage, and fix codecov url (#77)

---
 packages/octuple/README.md    | 24 +++++++++++++++++++++---
 packages/octuple/package.json |  4 ++++
 2 files changed, 25 insertions(+), 3 deletions(-)

diff --git a/packages/octuple/README.md b/packages/octuple/README.md
index 87e77832a..882509d3e 100644
--- a/packages/octuple/README.md
+++ b/packages/octuple/README.md
@@ -6,7 +6,7 @@
 
 <div align="center">
 
-[![npm version](https://badge.fury.io/js/@eightfold.ai%2Foctuple.svg)](https://badge.fury.io/js/@eightfold.ai%2Foctuple) ![node](https://img.shields.io/badge/node-16.14.2-brightgreen.svg) [![codecov](https://codecov.io/gh/yrchhabra-eightfold/octuple/branch/main/graph/badge.svg?token=K2BV6M1JS5)](https://codecov.io/gh/yrchhabra-eightfold/octuple) ![Build](https://github.com/EightfoldAI/octuple/actions/workflows/build.yml/badge.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![npm version](https://badge.fury.io/js/@eightfold.ai%2Foctuple.svg)](https://badge.fury.io/js/@eightfold.ai%2Foctuple) ![node](https://img.shields.io/badge/node-16.14.2-brightgreen.svg) [![codecov](https://codecov.io/gh/ychhabra-eightfold/octuple/branch/main/graph/badge.svg?token=K2BV6M1JS5)](https://codecov.io/gh/ychhabra-eightfold/octuple) ![Build](https://github.com/EightfoldAI/octuple/actions/workflows/build.yml/badge.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ![bundlesize-js-image](https://img.badgesize.io/https:/unpkg.com/browse/@eightfold.ai/octuple/lib/octuple.js?label=octuple.js&compression=gzip)
 ![bundlesize-css-image](https://img.badgesize.io/https:/unpkg.com/browse/@eightfold.ai/octuple/lib/octuple.css?label=octuple.css&compression=gzip)
@@ -28,9 +28,9 @@ It represents a collection of assets, utilities, and React components for buildi
 
 You can view the complete list of additions, fixes, and changes in the [change log](https://github.com/EightfoldAI/octuple/blob/main/CHANGELOG.md)
 
-## Usage
+## Install
 
-To use Octuple in your project run the following command:
+To install Octuple in your project run the following command:
 
 Yarn
 
@@ -44,6 +44,24 @@ NPM
 npm install @eightfold.ai/octuple
 ```
 
+## Usage
+
+```tsx
+import { PrimaryButton } from '@eightfold.ai/octuple';
+
+export const App = () => (
+    <>
+        <PrimaryButton text={'Button'} />
+    </>
+);
+```
+
+And import styles manually:
+
+```tsx
+import '@eightfold.ai/octuple/lib/octuple.css';
+```
+
 ## How can I contribute?
 
 There are many ways to contribute to the Octuple project. Review the following sections to find out which one is right for you.
diff --git a/packages/octuple/package.json b/packages/octuple/package.json
index ea1c364b0..c3695eb7d 100644
--- a/packages/octuple/package.json
+++ b/packages/octuple/package.json
@@ -4,6 +4,10 @@
     "license": "MIT",
     "main": "lib/octuple.js",
     "types": "lib/octuple.d.ts",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/EightfoldAI/octuple"
+    },
     "scripts": {
         "storybook": "start-storybook -p 2022",
         "build-storybook": "rm -rf dist && mkdir dist && build-storybook -o dist",