Skip to content

Commit 6e06729

Browse files
committed
docs: readme updated
1 parent 7ec2427 commit 6e06729

File tree

1 file changed

+42
-3
lines changed

1 file changed

+42
-3
lines changed

README.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
1-
# @epranka/create-tsx-package · [![GitHub license](https://img.shields.io/badge/license-ISC-blue.svg)](./LICENSE) [![npm version](https://img.shields.io/npm/v/@epranka/create-tsx-package.svg?style=flat)](https://www.npmjs.com/package/@epranka/create-tsx-package) [![npm downloads](https://img.shields.io/npm/dt/@epranka/create-tsx-package.svg?style=flat)](https://www.npmjs.com/package/@epranka/create-tsx-package) [![Build Status](https://travis-ci.org/epranka/create-tsx-package.svg?branch=master)](https://travis-ci.org/epranka/create-tsx-package) [![tweet](https://img.shields.io/twitter/url/http/github.com/epranka/create-tsx-package.svg?style=flat)](http%3A//twitter.com/share%3Ftext%3DHey%21%20I%20found%20this%21%26url%3Dhttps%3A//github.com/epranka/create-tsx-package)
2-
3-
Starter kit for React Typescript module
1+
<h1 align="center" style="border-bottom: none;">⚒️ @epranka/create-tsx-package</h1>
2+
3+
<h3 align="center">Starter kit for React Typescript module</h3>
4+
5+
<p align="center">
6+
<a href="./LICENSE">
7+
<img alt="license" src="https://img.shields.io/badge/license-ISC-blue.svg" />
8+
</a>
9+
<a href="https://www.npmjs.com/package/@epranka/create-tsx-package">
10+
<img alt="npm version" src="https://img.shields.io/npm/v/@epranka/create-tsx-package.svg?style=flat" />
11+
</a> <a href="https://www.npmjs.com/package/@epranka/create-tsx-package">
12+
<img alt="npm downloads" src="https://img.shields.io/npm/dt/@epranka/create-tsx-package.svg?style=flat" />
13+
</a> <a href="https://travis-ci.org/epranka/create-tsx-package">
14+
<img alt="build status" src="https://travis-ci.org/epranka/create-tsx-package.svg?branch=master" />
15+
</a> <a href="https://travis-ci.org/epranka/create-tsx-package">
16+
<img alt="ci travis" src="https://img.shields.io/badge/ci-travis-yellow" />
17+
</a> <a href="https://github.com/semantic-release/semantic-release">
18+
<img alt="semantic release" src="https://img.shields.io/badge/%E2%9C%A8-semantic--release-e10079" />
19+
</a>
20+
</p>
421

522
## Features
623

@@ -119,6 +136,28 @@ my-package
119136
$ yarn watch
120137
```
121138

139+
## Badge
140+
141+
Let people know that your package is generated using **@epranka/create-tsx-package** by including this badge in your readme
142+
143+
<a href="https://github.com/epranka/create-tsx-package">
144+
<img alt="generated with" src="https://img.shields.io/badge/generated%20with-%40epranka%2Fcreate--tsx--package-blue" />
145+
</a>
146+
147+
Using Markdown
148+
149+
```
150+
[![generated with @epranka/create-tsx-package](https://img.shields.io/badge/generated%20with-%40epranka%2Fcreate--tsx--package-blue)](https://github.com/epranka/create-tsx-package)
151+
```
152+
153+
Using HTML
154+
155+
```
156+
<a href="https://github.com/epranka/create-tsx-package">
157+
<img alt="generated with" src="https://img.shields.io/badge/generated%20with-%40epranka%2Fcreate--tsx--package-blue" />
158+
</a>
159+
```
160+
122161
## Author
123162

124163
Edvinas pranka ([epranka@gmail.com](mailto:epranka@gmail.com))

0 commit comments

Comments
 (0)