Skip to content

Commit 1eb0e47

Browse files
committed
prepare v0.1.0
1 parent d26d8e4 commit 1eb0e47

File tree

5 files changed

+36
-11
lines changed

5 files changed

+36
-11
lines changed

CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Change Log
2+
3+
All notable changes to the "react-github-buttons" project will be documented in this file.
4+
5+
## [0.1.0] 2019-6-13
6+
### Added
7+
8+
- Star and Fork button.

README.md

+25-8
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
55
[![NPM](https://img.shields.io/npm/v/react-github-buttons.svg)](https://www.npmjs.com/package/react-github-buttons) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
66

7+
## Features
8+
9+
Fork, GitHub's Star, Fork, Watch etc.(See full list below) buttons with realtime numbers of star, fork etc. as React Components.
10+
711
## Install
812

913
```bash
@@ -13,19 +17,32 @@ npm install --save react-github-buttons
1317
## Usage
1418

1519
```tsx
16-
import * as React from 'react'
20+
import React from 'react';
1721

18-
import MyComponent from 'react-github-buttons'
22+
import { Fork, Star } from 'react-github-buttons';
1923

20-
class Example extends React.Component {
21-
render () {
22-
return (
23-
<MyComponent />
24-
)
25-
}
24+
function App() {
25+
return (
26+
<div>
27+
<Star owner='facebook' repo='react' />
28+
<Fork owner='facebook' repo='react' />
29+
</div>
30+
)
2631
}
2732
```
2833

34+
## Release Notes
35+
36+
### 0.1.0
37+
38+
- Add Star and Fork button.
39+
40+
## Issues
41+
42+
Issues, bugs and feature request at https://github.com/vaibhavhrt/react-github-buttons/issues
43+
44+
-----------------------------------------------------------------------------------------------------------
45+
2946
## License
3047

3148
MIT © [vaibhavhrt](https://github.com/vaibhavhrt)

example/package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

example/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "react-github-buttons-example",
33
"homepage": "https://vaibhavhrt.github.io/react-github-buttons",
4-
"version": "0.0.0",
4+
"version": "0.1.0",
55
"license": "MIT",
66
"private": true,
77
"dependencies": {

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-github-buttons",
3-
"version": "1.0.0",
3+
"version": "0.1.0",
44
"description": "React Components for dynamic buttons for github repo&#x27;s star, fork etc.",
55
"author": "vaibhavhrt",
66
"license": "MIT",

0 commit comments

Comments
 (0)