Skip to content

Commit 5b23bbf

Browse files
fix: readme
1 parent eca4420 commit 5b23bbf

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,43 @@
1-
# react-virtualized-tree
1+
# react-vir-tree
22

33
[![Travis][build-badge]][build]
44
[![npm package][npm-badge]][npm]
55
[![Coveralls][coveralls-badge]][coveralls]
6-
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/react-virtualized-tree/Lobby)
76
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
87

9-
[build-badge]: https://img.shields.io/travis/diogofcunha/react-virtualized-tree/master.png?style=flat-square
10-
[build]: https://travis-ci.org/diogofcunha/react-virtualized-tree
11-
[npm-badge]: https://img.shields.io/npm/v/react-virtualized-tree.png?style=flat-square
12-
[npm]: https://www.npmjs.com/package/react-virtualized-tree
13-
[coveralls-badge]: https://img.shields.io/coveralls/diogofcunha/react-virtualized-tree/master.png?style=flat-square
14-
[coveralls]: https://coveralls.io/github/diogofcunha/react-virtualized-tree
8+
[build-badge]: https://img.shields.io/travis/highqualitycode/react-vir-tree/master.png?style=flat-square
9+
[build]: https://travis-ci.org/highqualitycode/react-vir-tree
10+
[npm-badge]: https://img.shields.io/npm/v/react-vir-tree.png?style=flat-square
11+
[npm]: https://www.npmjs.com/package/react-vir-tree
12+
[coveralls-badge]: https://img.shields.io/coveralls/highqualitycode/react-vir-tree/master.png?style=flat-square
13+
[coveralls]: https://coveralls.io/github/highqualitycode/react-vir-tree
1514

1615
<div align="center" style="margin-bottom: 30px;">
1716
<img src="https://user-images.githubusercontent.com/1521183/37708046-14cf3fb4-2cfd-11e8-9fad-8c0d557397cd.gif" width="650"/>
1817
</div>
1918

2019
## Introduction
2120

22-
**react-virtualized-tree** is a tree view react library built on top of [react-virtualized](https://bvaughn.github.io/react-virtualized/#/components/List)
21+
**react-vir-tree** is a tree view react library built on top of [react-virtualized](https://bvaughn.github.io/react-virtualized/#/components/List)
2322

2423
Its main goal is to display tree like data in a beautiful and fast way. Being a reactive library it uses children functions to achieve maximum extensibility. The core idea behind it is that anyone using it is enable to create a tree as they intent just by rendering their own components or components exported by the tree.
2524

26-
Demo and docs can be found [in here](https://diogofcunha.github.io/react-virtualized-tree/#/examples/basic-tree).
25+
Demo and docs can be found [in here](https://highqualitycode.github.io/react-vir-tree/).
2726

2827
## Installation
2928

3029
You can install via npm or yarn.
31-
`npm i react-virtualized-tree --save`
30+
`npm i react-vir-tree --save`
3231

3332
or
3433

35-
`yarn add react-virtualized-tree`
34+
`yarn add react-vir-tree`
3635

3736
To get the basic styles for free you need to import react-virtualized styles only once.
3837

3938
```
4039
import 'react-virtualized/styles.css'
41-
import 'react-virtualized-tree/lib/main.css'
40+
import 'react-vir-tree/lib/main.css'
4241
```
4342

4443
If you want to use the icons in the default renderers do the same for material icons.
@@ -49,12 +48,12 @@ If you want to use the icons in the default renderers do the same for material i
4948

5049
To use the standalone tree
5150

52-
`import Tree from 'react-virtualized-tree'`
51+
`import Tree from 'react-vir-tree'`
5352

5453
To use the FilteringContainer
5554

56-
`import { FilteringContainer } from 'react-virtualized-tree'`
55+
`import { FilteringContainer } from 'react-vir-tree'`
5756

5857
## Dependencies
5958

60-
Most react-virtualized-tree Dependencies are managed internally, the only required peerDependencies are **react**, **react-dom** and **react-virtualized**.
59+
Most react-vir-tree Dependencies are managed internally, the only required peerDependencies are **react**, **react-dom** and **react-virtualized**.

0 commit comments

Comments
 (0)