Comparing version 6.1.3 to 6.1.4
@@ -5,2 +5,12 @@ # Change Log | ||
<a name="6.1.4"></a> | ||
## [6.1.4](https://github.com/BHP-DevHub/bhp-ui/compare/v6.1.3...v6.1.4) (2018-09-04) | ||
### Bug Fixes | ||
* enable theme for select component ([a66f730](https://github.com/BHP-DevHub/bhp-ui/commit/a66f730)) | ||
<a name="6.1.3"></a> | ||
@@ -7,0 +17,0 @@ ## [6.1.3](https://github.com/BHP-DevHub/bhp-ui/compare/v6.1.2...v6.1.3) (2018-08-08) |
{ | ||
"name": "@bhp/ui", | ||
"version": "6.1.3", | ||
"version": "6.1.4", | ||
"publishConfig": { | ||
@@ -5,0 +5,0 @@ "registry": "https://registry.npmjs.org/" |
@@ -1,3 +0,14 @@ | ||
# BHP UI | ||
<p align="left"> | ||
<a href="https://bhp-devhub.github.io/bhp-digital-design-system/"> | ||
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/BHP_2017_logo.svg/167px-BHP_2017_logo.svg.png" alt="BHP logo"h height="40"> | ||
</a> | ||
</p> | ||
<p> | ||
<a href="https://bhp-devhub.github.io/bhp-digital-design-system/">Read the docs</a> | ||
· | ||
<a href="mailto:UserExperience@bhpbilliton.com">Request feature</a> | ||
</p> | ||
# BHP UI Bootstrap Library | ||
<!-- Badges section here. --> | ||
@@ -7,21 +18,36 @@ [![Build Status](https://travis-ci.org/BHP-DevHub/bhp-ui.svg?branch=master)](https://travis-ci.org/BHP-DevHub/bhp-ui) | ||
BHP UI library. A customised Bootstrap deployment with three themes, along with | ||
some extra components. | ||
The base HTML/CSS package for BHP Digital Design System. A customised Bootstrap deployment with extra custom components. Also available in [Material UI](https://github.com/BHP-DevHub/bhp-ui-material) framework. | ||
## Getting started: With NPM | ||
### Getting started: With NPM | ||
If you are using `npm` or `yarn` in your project, run: | ||
``` | ||
yarn add @bhp/ui bootstrap | ||
npm install @bhp/ui | ||
``` | ||
Then import the SASS file below in your project: | ||
### Getting started: With Yarn | ||
``` | ||
@import "node_modules/@bhp/ui/scss/index"; | ||
yarn add @bhp/ui | ||
``` | ||
## Getting started: No NPM | ||
Download the `css/index-dark.css` or `css/index-light.css` files and add them to your static site. | ||
You need to add `class="light-theme"` or `class="dark-theme"` to the root `html` element of your project. | ||
### Getting started: With GitHub | ||
Clone this [GitHub repository](https://github.com/BHP-DevHub/bhp-ui) to your project folder. | ||
## Using BHP UI in HTML/CSS Project | ||
Import the SCSS theme file in your project. You have a choice of dark theme `/scss/index-dark.scss`, warm theme `/scss/index-warm.scss` or light theme `/scss/index-light.scss`. | ||
Any custom style or style override are to be added after. | ||
## Using BHP UI in React Project | ||
Please visit the React companion repository. Click here: [BHP UI Bootstrap React](https://github.com/BHP-DevHub/bhp-ui-react) | ||
## Using BHP UI in Angular Project | ||
Please visit the Angular companion repository. Click here: [BHP UI Bootstrap Angular](https://github.com/BHP-DevHub/bhp-ui-angular) | ||
--- | ||
Please refer to the [online documentation](https://bhp-devhub.github.io/bhp-digital-design-system/) on how to create and add component into your project. |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
808469
40
25882
53