Skip to content

Commit ef816c1

Browse files
committed
Update README.md
1 parent 46af6c7 commit ef816c1

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
*for HTML divs in React.js*
44

5-
`react-round-div` makes your rounded rectangles look smoother for a more pleasant feel. With a simple and easy
6-
integration into your code you have to do almost nothing to up the style of your project.
5+
`react-round-div` makes your rounded rectangles look smoother for a more pleasant feel. The package
6+
weighs [just under 10KB](#size) and has an almost "plug and play"-integration into your code, so that you have to do
7+
next to nothing to up the style of your project.
78

89
Here is a very clear demonstration of these smooth corners:
910

@@ -14,6 +15,7 @@ Here is a very clear demonstration of these smooth corners:
1415
- [Options](#options)
1516
- [`dontConvertShadow`](#dontconvertshadow)
1617
- [Things to note & caveats](#things-to-note--caveats)
18+
- [Intended differences to the html `<div>`](#intended-differences-to-the-html-div)
1719
- [webpack](#webpack)
1820

1921
## Installation
@@ -67,20 +69,24 @@ your `box-shadow`s, add the `dontConvertShadow` option:
6769

6870
## Things to note & caveats
6971

70-
This package is still in the starting blocks, so for now borders are only supported in the `solid` style and some
71-
transitions, and animations on the div may not work properly.
72+
This package is still in the starting blocks, some cases where it might not behave as expected. For example, some border
73+
styles are not rendered correctly, and some transitions and animations on the div may not work properly.
7274

73-
There are a couple of css properties, that you can't reliably set with `RoundDiv`:
75+
There are a couple of css properties, that you can't reliably set _inline_ with `RoundDiv`:
7476

7577
- the `background` property and all the properties it is a shorthand for
76-
- `border-color`
78+
- the `border`, `border-image`, and all the properties they are a shorthand for
7779
- `box-shadow`
7880
- `filter`, if you haven't set [`dontConvertShadow`](#dontconvertshadow)
7981

80-
You shouldn't set these properties inline. Instead, set them in a stylesheet. This may change in future versions.
81-
The `filter` property in particular will not work at all, if you have set a `box-shadow` AND have not
82+
You shouldn't set these properties inline. Instead, set them in a stylesheet. This behaviour may change in future
83+
versions. The `filter` property in particular will only not work, if you have set a `box-shadow` AND have not
8284
set [`dontConvertShadow`](#dontconvertshadow). This may also change in future versions.
8385

86+
### Intended differences to the html `<div>`
87+
88+
Unlike the html `<div>`, `RoundDiv` still rounds the corners of borders of there is a border image set. This looks great with gradients, but might clash with the use of actual images as borders.
89+
8490
### webpack
8591

8692
If you use a preprocessor like webpack (which you most likely are), you need to turn off or polyfill the node

0 commit comments

Comments
 (0)