diff --git a/README.md b/README.md index dcffa93..0cecd31 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,9 @@ img2 = clipboard_img() img == img2 ``` -## Sample screenshots (old) -![](docs/src/img/clipboard_img.gif) +## Sample screenshots +### Paste an image +![](docs/src/img/screenshot_paste.gif) -![](docs/src/img/clipboard_img2.gif) +### Copy an image +![](docs/src/img/screenshot_copy.gif) diff --git a/docs/src/index.md b/docs/src/index.md index 4d2ae04..5aff58c 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -4,7 +4,38 @@ CurrentModule = ImageClipboard # ImageClipboard -Documentation for [ImageClipboard](https://github.com/hyrodium/ImageClipboard.jl). +Copy & Paste images with Julia + +## Install +``` +(@v1.6) pkg> add https://github.com/hyrodium/ImageClipboard.jl +``` + +## Usage +```julia +using Images, ImageClipboard + +# Create random image +img = rand(RGB{N0f8}, 100, 200) + +# Copy to clipboard +clipboard_img(img) + +# Paste image from clipboard +img2 = clipboard_img() + +# These are the same images +img == img2 +``` + +## Sample screenshots +### Paste an image +![](img/screenshot_paste.gif) + +### Copy an image +![](img/screenshot_copy.gif) + +## docstrings ```@index ```