Skip to content

Commit

Permalink
doc(phylopic): README
Browse files Browse the repository at this point in the history
  • Loading branch information
@tpoisot
tpoisot committed May 6, 2024
1 parent ad690cd commit a4f2ec3
Showing 1 changed file with 1 addition and 16 deletions.
17 changes: 1 addition & 16 deletions Phylopic/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
# Phylopic.jl

This package is a *thin* wrapper around the Phylopic API, which is currently not covering
the entire API.

~~~julia
using Phylopic
import Downloads

# Get a series of UUIDs from a name
org_uuid = Phylopic.imagesof("chiroptera"; items=1)

# We can query the thumbnails for this UUID
thumb_url = Phylopic.thumbnail(org_uuid)

# We can download the thumbnail (to a temp file)
thumb_file = Downloads.download(first(thumb_url))
~~~
See the main package documentation: https://poisotlab.github.io/SpeciesDistributionToolkit.jl/dev/

2 comments on commit a4f2ec3

@tpoisot
Copy link
Member Author

@tpoisot tpoisot commented on a4f2ec3 May 6, 2024

Choose a reason for hiding this comment

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

@JuliaRegistrator register() subdir="Phylopic"

@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/106268

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

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 Phylopic-v0.0.5 -m "<description of version>" a4f2ec328d408f5257acf27df8647251a01f924b
git push origin Phylopic-v0.0.5

Please sign in to comment.