Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
dfee committed Dec 13, 2018
1 parent 09a4f72 commit 9833889
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## πŸ‘Ÿ rbx :: UI Components for React, Based on Bulma
## πŸ‘Ÿ rbx – The Comprehensive Bulma UI Framework for React

[![Build Status](https://travis-ci.org/dfee/rbx.svg?branch=master)](https://travis-ci.org/dfee/rbx)
[![Coverage Status](https://coveralls.io/repos/github/dfee/rbx/badge.svg?branch=master)](https://coveralls.io/github/dfee/rbx?branch=master)
Expand All @@ -7,7 +7,8 @@

[Bulma](http://bulma.io) components for the React framework.

You can find the Storybook stories of all components [here](https://dfee.github.io/rbx/)
πŸ”₯ **All components have exhaustive** [storybook examples](https://dfee.github.io/rbx).
πŸ™ƒ _I'll wait, go check them out!_

### To Install

Expand Down Expand Up @@ -51,9 +52,6 @@ export const MyPage = () => (

### Library

All components have been ported and have exhaustive [storybook examples](https://dfee.github.io/rbx).
You should check them out!

All components support ref-forwarding, and are able to render as any other React Component Type you want to provide, by using the special prop `as`.
For example, to render a `Button` component as a `react-router` `Link`:

Expand Down Expand Up @@ -228,3 +226,4 @@ exports.onCreateWebpackConfig = ({
This library was hard-forked from [`react-bulma-components`](https://github.com/couds/react-bulma-components) and has been rewritten in its entirety from scratch.

If you're coming from that library, expect some breaking changes - largely due to stylistic interpretations of the Bulma API and a propensity to keep the React component names semantic.
In addition, there were **many** additions and bug fixes required to bring this library into compliance with the latest release of Bulma.

0 comments on commit 9833889

Please sign in to comment.