Skip to content

Commit 9e53296

Browse files
author
Adrian Florescu
committed
feat(readme): updated readme
1 parent a5af357 commit 9e53296

File tree

1 file changed

+2
-48
lines changed

1 file changed

+2
-48
lines changed

README.md

Lines changed: 2 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,6 @@
1-
# Boilerplate for React UI libraries
2-
[![Build Status](https://travis-ci.org/adyz/test-react-ts-npm-package.svg?branch=master)](https://travis-ci.org/adyz/test-react-ts-npm-package)
1+
# React tree grid (Flatten)
2+
[![Build Status](https://travis-ci.org/adyz/react-tree-grid.svg?branch=master)](https://travis-ci.org/adyz/react-tree-grid)
33

4-
This is a boilerplate that allows you to create your own react components with React and Typescript.
5-
Bellow you'll find a description on how to use this project from different points of view: User, Contributor and Creator.
6-
7-
## Using this project as a library
8-
9-
### Install
10-
Run `npm install --save-dev test-react-ts-npm-package`
11-
12-
### Import single components (smaller bundle size)
13-
```js
14-
15-
import Banner from "test-react-ts-npm-package/dist/banner";
16-
import Button from "test-react-ts-npm-package/dist/button";
17-
18-
function App() {
19-
return (
20-
<div>
21-
<Banner name="John" />
22-
<Button>Go</Button>
23-
</div>
24-
);
25-
}
26-
```
27-
[![Edit Usage of the test-react-ts-npm-package with simple react](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/64m89m9pj3)
28-
29-
### Import the full library
30-
```js
31-
32-
import Banner, { Button } from "test-react-ts-npm-package";
33-
import
34-
35-
function App() {
36-
return (
37-
<div>
38-
<Banner name="Doe" />
39-
<Button>Planet</Button>
40-
</div>
41-
);
42-
}
43-
```
44-
45-
46-
## Using this project as boilerplate
47-
- Clone this project
48-
- Modify the `package.json` file so that the new package name, version, etc fits your need.
49-
- Follow the steps from bellow
504

515
## Using this project as contributor
526
- Clone this project

0 commit comments

Comments
 (0)