Skip to content
This repository was archived by the owner on Mar 1, 2024. It is now read-only.

Commit 877bdcb

Browse files
committed
Readme updates and package version bump
1 parent 5ee1501 commit 877bdcb

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# Tabler React
22

3-
> Work in progress React implementation of the [Tabler Dashboard UI Kit](https://github.com/tabler/tabler)
3+
> React implementation of the [Tabler Dashboard UI Kit](https://github.com/tabler/tabler)
44
55
[![NPM](https://img.shields.io/npm/v/tabler-react.svg)](https://www.npmjs.com/package/tabler-react) ![Type definitions](https://img.shields.io/badge/type%20definitions-flow-green.svg)
66

7-
**[View the demo](https://tabler.github.io/tabler-react/)** | **[track our progress towards version 1](https://github.com/tabler/tabler-react/projects/1)** | **[get involved](https://github.com/tabler/tabler-react/issues)** | **[chat to us on Slack](https://tabler-ui.slack.com/messages/CA55LDVHU/)**.
7+
**[Demo](https://tabler.github.io/tabler-react/)** | **[Documentation](https://tabler.github.io/tabler-react/)** | **[Issues](https://github.com/tabler/tabler-react/issues)** | **[Slack](https://tabler-ui.slack.com/messages/CA55LDVHU/)**.
8+
9+
> Please note: we're working fast towards [version 1.0](https://github.com/tabler/tabler-react/milestone/1) and until then all releases should be considered unstable and potentially breaking
810
911
## Install
1012

1113
Make sure you have [Node.js](https://nodejs.org/) 8+ and [npm](https://npmjs.com/) installed.
1214

1315
`npm install --save tabler-react` or `yarn add tabler-react`
1416

15-
## Usage
17+
## Example
1618

1719
```jsx
1820
import React, { Component } from "react";
@@ -35,7 +37,7 @@ class MyCard extends Component {
3537
}
3638
```
3739

38-
For more examples see the [demo website](https://tabler.github.io/tabler-react/)
40+
For more examples and documentation see the [demo website](https://tabler.github.io/tabler-react/)
3941

4042
## Contributing
4143

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "tabler-react",
3-
"version": "0.0.2",
3+
"version": "0.0.3",
44
"description": "",
55
"author": "jonthomp and AaronCoplan",
66
"license": "MIT",

0 commit comments

Comments
 (0)