From e40031b0021c0c727bfb2fcfe528c4464d5061e9 Mon Sep 17 00:00:00 2001 From: Yash Raj Chhabra Date: Wed, 20 Apr 2022 10:50:32 +0530 Subject: [PATCH 1/2] chore: update readme with usage, and fix codecov url --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 87e77832a..882509d3e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@
-[![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 = () => ( + <> + + +); +``` + +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. From ba9fd6637f93347ca5682b9d98059143df0a909f Mon Sep 17 00:00:00 2001 From: Yash Raj Chhabra Date: Wed, 20 Apr 2022 10:58:22 +0530 Subject: [PATCH 2/2] chore: add repo url to package.json --- package.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/package.json b/package.json index d8290ec5d..9e3ed2c9b 100644 --- a/package.json +++ b/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",