Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update readme with usage, and fix codecov url #77

Merged
merged 4 commits into from
Apr 20, 2022
+25 −3
Merged

chore: update readme with usage, and fix codecov url #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e40031b
chore: update readme with usage, and fix codecov url
ychhabra-eightfold Apr 20, 2022
78244b7
Merge branch 'main' into readmeUsage
ychhabra-eightfold Apr 20, 2022
ba9fd66
chore: add repo url to package.json
ychhabra-eightfold Apr 20, 2022
014ea23
Merge branch 'readmeUsage' of github.com:yrchhabra-eightfold/octuple …
ychhabra-eightfold Apr 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

Expand All @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down