Skip to content

Commit c0f2343

Browse files
committed
Updated readme
1 parent 6acfb8f commit c0f2343

File tree

1 file changed

+61
-16
lines changed

1 file changed

+61
-16
lines changed

README.md

Lines changed: 61 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![npm version](https://badge.fury.io/js/react-notifications-component.svg)](https://badge.fury.io/js/react-notifications-component) [![Build Status](https://travis-ci.org/teodosii/react-notifications-component.svg?branch=master)](https://travis-ci.org/teodosii/react-notifications-component) [![Coverage Status](https://coveralls.io/repos/github/teodosii/react-notifications-component/badge.svg?branch=master)](https://coveralls.io/github/teodosii/react-notifications-component?branch=master) [![dependencies Status](https://david-dm.org/teodosii/react-notifications-component/status.svg)](https://david-dm.org/teodosii/react-notifications-component) [![peerDependencies Status](https://david-dm.org/teodosii/react-notifications-component/peer-status.svg)](https://david-dm.org/teodosii/react-notifications-component?type=peer) [![devDependencies Status](https://david-dm.org/teodosii/react-notifications-component/dev-status.svg)](https://david-dm.org/teodosii/react-notifications-component?type=dev)
1+
[![npm version](https://badge.fury.io/js/react-notifications-component.svg)](https://badge.fury.io/js/react-notifications-component) [![Build Status](https://travis-ci.org/teodosii/react-notifications-component.svg?branch=master)](https://travis-ci.org/teodosii/react-notifications-component) [![Coverage Status](https://coveralls.io/repos/github/teodosii/react-notifications-component/badge.svg?branch=master)](https://coveralls.io/github/teodosii/react-notifications-component?branch=master)
22

33
# react-notifications-component
44

@@ -12,20 +12,64 @@ https://teodosii.github.io/react-notifications-component/
1212

1313
## Features
1414

15-
- Touch support :heavy_check_mark:
16-
- Responsive notifications :heavy_check_mark:
17-
- Standard notification types (`default`, `success`, `info`, `danger`, `warning`) :heavy_check_mark:
18-
- Custom notification types :heavy_check_mark:
19-
- Custom notification content (`images`, `icons` etc) :heavy_check_mark:
20-
- Dismiss after timeout :heavy_check_mark:
21-
- Dismissable by swiping :heavy_check_mark:
22-
- Dismissable by clicking :heavy_check_mark:
23-
- Dismissable by custom X icon :heavy_check_mark:
24-
- Custom animations on show :heavy_check_mark:
25-
- Custom animations on exit :heavy_check_mark:
26-
- Custom transitions on sliding :heavy_check_mark:
27-
- Custom transitions on swiping :heavy_check_mark:
28-
- Notification insertion at both ends of container :heavy_check_mark:
15+
<table>
16+
<tr>
17+
<td>Touch support</td>
18+
<td>:heavy_check_mark:</td>
19+
</tr>
20+
<tr>
21+
<td>Responsive notifications</td>
22+
<td>:heavy_check_mark:</td>
23+
</tr>
24+
<tr>
25+
<td>Standard notification types (<code>default</code>, <code>success</code>, <code>info</code>, <code>danger</code>, <code>warning</code>)</td>
26+
<td>:heavy_check_mark:</td>
27+
</tr>
28+
<tr>
29+
<td>Custom notification types</td>
30+
<td>:heavy_check_mark:</td>
31+
</tr>
32+
<tr>
33+
<td>Custom notification content - <code>images</code>, <code>icons</code> etc</td>
34+
<td>:heavy_check_mark:</td>
35+
</tr>
36+
<tr>
37+
<td>Dismiss after timeout</td>
38+
<td>:heavy_check_mark:</td>
39+
</tr>
40+
<tr>
41+
<td>Dismissable by swiping</td>
42+
<td>:heavy_check_mark:</td>
43+
</tr>
44+
<tr>
45+
<td>Dismissable by clicking</td>
46+
<td>:heavy_check_mark:</td>
47+
</tr>
48+
<tr>
49+
<td>Dismissable by custom &times; icon</td>
50+
<td>:heavy_check_mark:</td>
51+
</tr>
52+
<tr>
53+
<td>Custom animations on show</td>
54+
<td>:heavy_check_mark:</td>
55+
</tr>
56+
<tr>
57+
<td>Custom animations on exit</td>
58+
<td>:heavy_check_mark:</td>
59+
</tr>
60+
<tr>
61+
<td>Custom transitions on sliding</td>
62+
<td>:heavy_check_mark:</td>
63+
</tr>
64+
<tr>
65+
<td>Custom transitions on swiping</td>
66+
<td>:heavy_check_mark:</td>
67+
</tr>
68+
<tr>
69+
<td>Notification insertion at both ends of container</td>
70+
<td>:heavy_check_mark:</td>
71+
</tr>
72+
</table>
2973

3074
## Install
3175

@@ -44,6 +88,7 @@ For further information on supported options, check documentation.
4488
```jsx
4589
import React from "react";
4690
import ReactNotification from "react-notifications-component";
91+
import "react-notifications-component/dist/theme.css";
4792

4893
class App extends React.Component {
4994
constructor(props) {
@@ -79,7 +124,7 @@ class App extends React.Component {
79124
}
80125
```
81126

82-
**Note:** It is important to import `react-notifications-component` CSS theme, which is located in `dist\theme.css`
127+
**Note:** It is important to import `react-notifications-component` CSS theme, which is located in `dist/theme.css`
83128

84129
## Development
85130

0 commit comments

Comments
 (0)