Skip to content

Commit 2e26e60

Browse files
Update README.md
1 parent b459b58 commit 2e26e60

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
# @clampy-js/react-clampy
22

3-
> React component that clamps the content of an element by adding an ellipsis to it if the content inside is too long.
3+
React component that clamps the content of an element by adding an ellipsis to it if the content inside is too long.
44

5-
[![NPM](https://img.shields.io/npm/v/@clampy-js/react-clampy.svg)](https://www.npmjs.com/package/@clampy-js/react-clampy) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
5+
[![Build Status](https://img.shields.io/travis/clampy-js/react-clampy.svg)](https://travis-ci.org/clampy-js/react-clampy)
6+
[![GitHub issues](https://img.shields.io/github/issues/clampy-js/react-clampy.svg)](https://github.com/clampy-js/react-clampy/issues)
7+
[![GitHub license](https://img.shields.io/github/license/clampy-js/react-clampy.svg)](https://github.com/clampy-js/react-clampy/blob/master/LICENSE)
8+
[![npm](https://img.shields.io/npm/dt/@clampy-js/react-clampy.svg)](https://www.npmjs.com/package/@clampy-js/react-clampy)
9+
10+
It uses [@clampy-js/clampy](https://github.com/clampy-js/clampy) library (a fork of [Clamp.js](https://github.com/josephschmitt/Clamp.js)) behind the scene to apply the ellipsis.
11+
12+
It automatically re-clamps itself when the element or the browser window change size.
613

714
## Install
815

0 commit comments

Comments
 (0)