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

Commit 111bcfa

Browse files
committed
docs(README): update README with brief information
1 parent 14478f3 commit 111bcfa

File tree

2 files changed

+84
-5
lines changed

2 files changed

+84
-5
lines changed

README.md

Lines changed: 74 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,82 @@
1-
### Install Dependencies
1+
# Blueprint Components
2+
3+
The missing components for [Blueprint](http://blueprintjs.com/).
4+
5+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
6+
[![Travis](https://img.shields.io/travis/Landish/blueprint-components.svg)](https://travis-ci.org/Landish/blueprint-components)
7+
[![Tested with Jest](https://img.shields.io/badge/tested_with-jest-brightgreen.svg)](https://github.com/facebook/jest)
8+
[![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)
9+
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
10+
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
11+
[![license](https://img.shields.io/github/license/Landish/blueprint-components.svg)](https://github.com/Landish/blueprint-components/blob/master/LICENSE)
12+
13+
14+
## Getting Started
15+
16+
Install Blueprint Components
17+
18+
```
19+
yarn add blueprint-components
20+
```
21+
22+
Add specific component to your project:
23+
24+
```js
25+
import { ButtonGroup, Label, Navbar, ... } from 'blueprint-components';
26+
```
27+
28+
### Avalaible Components:
29+
30+
* [Button Group](https://landish.github.io/blueprint-components/#buttongroup)
31+
* [Callout](https://landish.github.io/blueprint-components/#callout)
32+
* [Card](https://landish.github.io/blueprint-components/#card)
33+
* [Control Group](https://landish.github.io/blueprint-components/#controlgroup)
34+
* [File Input](https://landish.github.io/blueprint-components/#fileinput)
35+
* [Form Group](https://landish.github.io/blueprint-components/#formgroup)
36+
* [Label](https://landish.github.io/blueprint-components/#label)
37+
* [Navbar](https://landish.github.io/blueprint-components/#navbar)
38+
39+
## Contirbution
40+
41+
PR's are welcome. If you found a bug, typo, or just want to add new features or examples to docs, feel free to make a pull request.
42+
243
```
44+
git clone [email protected]:Landish/blueprint-components.git
45+
cd blueprint-components
346
yarn
447
```
548

6-
### Run Docs
49+
Once you've forked/cloned the repo, you can fix the bug, or add new feature.
50+
51+
If you need to open docs on local machine, run the following command:
52+
753
```
854
yarn docs
955
```
1056

11-
Visit [http://localhost:6060/](http://localhost:6060/)
57+
Then visit [http://localhost:6060/](http://localhost:6060/)
58+
59+
If you need to check the tests, run the command:
60+
61+
```
62+
yarn test
63+
# Or run the tests in `watch` mode
64+
yarn test:watch
65+
```
66+
67+
After you've made your changes, add files to git stage with `git add <file(s)>` and then run the following command instead of `git commit -m "your message"`:
68+
69+
```
70+
yarn cz
71+
```
72+
73+
It will prompt few questions from [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog). After you answer them correctly, you're ready to make a pull request.
74+
75+
> Note: Don't worry about formatting the code, [prettier](https://github.com/prettier/prettier) will do it for you with `precommit` hook, thanks to [husky](https://github.com/typicode/husky) and [lint-staged](https://github.com/okonet/lint-staged).
76+
77+
78+
## Licence
79+
80+
The Blueprint Components package is licensed under [MIT License](https://github.com/Landish/blueprint-components/blob/master/LICENSE).
81+
82+
> Note: [Blueprint](http://blueprintjs.com/) itself is licensed under [BSD](https://github.com/palantir/blueprint/blob/master/LICENSE).

docs/index.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Blueprint Components
22

3-
> The missing components for [Blueprint](http://blueprintjs.com/).
4-
>
3+
The missing components for [Blueprint](http://blueprintjs.com/).
4+
55
> **Note:** *[Blueprint](http://blueprintjs.com/) is a React-based UI toolkit for the web.*
66
77
## Getting Started
@@ -11,3 +11,11 @@
1111
```shell
1212
$ yarn add blueprint-components
1313
```
14+
15+
### Usage
16+
17+
Add specific component to your project:
18+
19+
```js static
20+
import { ButtonGroup, Label, Navbar, ... } from 'blueprint-components';
21+
```

0 commit comments

Comments
 (0)