diff --git a/README.md b/README.md index 75b2e06..41858f4 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,35 @@

-# GNAvatarView -Component avatar view for javafx-8 +

+ +

-![gif](src/com/gn/gif.gif) +

+
This project is part of the set of custom components created for JavaFx.
+ +

+ +

GNAvatarView

+ +
+ The AvatarView is a simple component used to view one image with a custom avatar. + +
+ + > Create a shape with image for avatar view. + +

+ +
Basic Usage
+ +```java +GNAvatarView avatarView = new GNAvatarView(); +avatarView.setImage(new Image("smile.jpg")); +``` + +

+ +
View
+ +