Initial commit (Now with npm installation)
This commit is contained in:
29
README.md
Normal file
29
README.md
Normal file
@ -0,0 +1,29 @@
|
||||
# Introduction
|
||||
|
||||
> This is a module extends **React**
|
||||
|
||||
This FancyImage React component creates an animation on image change and can be used as nice and material headline design with image.
|
||||
|
||||
# Installation
|
||||
|
||||
`npm install react-fancy-image` --save
|
||||
|
||||
# Usage
|
||||
|
||||
Add following line at the beginning of your document:
|
||||
|
||||
`import ReactFancyImage from 'react-fancy-image'`
|
||||
|
||||
Use the ReactFancyImage component:
|
||||
|
||||
`<Image img={require(imgUrl)} headlineA="" headlineB="" />`
|
||||
|
||||
> The image is displayed 'absolute'. To embed it into your website it is recommended to use a parent `<div style={position: "relative"}>`.
|
||||
|
||||
# Contact
|
||||
|
||||
**Github:** https://github.com/aleabodo
|
||||
|
||||
**Wesite:** https://alexbell.de
|
||||
|
||||
**Email:** mail@alexbell.de
|
Reference in New Issue
Block a user