Skip to content

Commit

Permalink
Merge pull request #30 from hyrodium/feature/moredocs
Browse files Browse the repository at this point in the history
Fix typo, add related packages
  • Loading branch information
hyrodium authored Jun 19, 2021
2 parents e59f9e9 + e8cee63 commit be8d53c
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 13 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ImageClipboard"
uuid = "6db54171-f50f-4661-a74f-bc514ef16cee"
authors = ["hyrodium <[email protected]> and contributors"]
version = "0.1.1"
version = "0.1.2"

[deps]
ColorTypes = "3da002f7-5984-5a60-b8a6-cbb66c0b333f"
Expand Down
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,22 @@ pkg> add ImageClipboard
```

## Usage

Just like `clipboard` in InteractiveUtils deals with string contents, this package provides `clipboard_img` to work with image contents:

```julia
using Images, ImageClipboard

# Create random image
# Create a random image
img = rand(RGB{N0f8}, 100, 200)

# Copy to clipboard
# Copy the image to the clipboard
clipboard_img(img)

# Paste image from clipboard
# Paste the image from the clipboard
img2 = clipboard_img()

# These are the same images
img == img2
img == img2 # true
```

## Sample screenshots
Expand All @@ -40,7 +39,7 @@ img == img2


### Julia Compatibility
For Julia versions older than `v"1.3"`, you need to manually install the image IO backend [ImageMagick.jl](https://github.com/JuliaIO/ImageMagick.jl) first.

For Julia versions older than v"1.3", you need to manually install the image IO backend [ImageMagcik.jl] first.

[ImageMagick.jl]: https://github.com/JuliaIO/ImageMagick.jl
### Other related packages
* [ClipData.jl](https://github.com/pdeffebach/ClipData.jl) enables users to copy/paste to/from Excel, Google Sheets, and other tabular data sources into interactive Julia sessions.
15 changes: 11 additions & 4 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,22 @@ pkg> add ImageClipboard
```

## Basic usage
Just like `clipboard` in InteractiveUtils deals with string contents, this package provides `clipboard_img` to work with image contents:

```julia
using Images, ImageClipboard

# Create random image
# Create a random image
img = rand(RGB{N0f8}, 100, 200)

# Copy to clipboard
# Copy the image to the clipboard
clipboard_img(img)

# Paste image from clipboard
# Paste the image from the clipboard
img2 = clipboard_img()

# These are the same images
img == img2
img == img2 # true
```

## Sample screenshots
Expand All @@ -35,3 +36,9 @@ img == img2

### Paste an image
![](img/screenshot_paste.gif)

### Julia Compatibility
For Julia versions older than `v"1.3"`, you need to manually install the image IO backend [ImageMagick.jl](https://github.com/JuliaIO/ImageMagick.jl) first.

### Other related packages
* [ClipData.jl](https://pdeffebach.github.io/ClipData.jl/dev/) enables users to copy/paste to/from Excel, Google Sheets, and other tabular data sources into interactive Julia sessions.

2 comments on commit be8d53c

@hyrodium
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/39202

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.2 -m "<description of version>" be8d53c481fdc3c410632026c538701c27f4a7e6
git push origin v0.1.2

Please sign in to comment.