Skip to content

Commit

Permalink
Add keywords and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pohlm01 committed Oct 30, 2023
1 parent b5334b6 commit 30a0e92
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 3 deletions.
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
name = "image_thumbs"
version = "0.1.0"
edition = "2021"
repository = "https://github.com/tweedegolf/image-thumbs"
keywords = ["GCS", "image", "thumbnails"]
license = "MIT OR Apache-2.0"
description = "Simple to use crate to create thumbnails and store them in a object store like Google Cloud Storage"

[[example]]
name = "basic"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
object_store = { version = "0.7" , features = ["gcp"]}
image = { version = "0.24.7", default-features = false, features = ["png", "jpeg"] }
Expand Down
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Image Thumbs

Easy-to-use library to create image thumbnails from images existing on some (cloud) object storage or from disk.

Currently implemented is a connection to Google Cloud Storage, but it can be easily extended to other providers.

# How to use

```rust
#[tokio::main]
async fn main() {
let thumbs = image_thumbs::ImageThumbs::new("examples/image_thumbs")
.await
.unwrap();
thumbs
.create_thumbs("penguin.jpg", "/thumbs", false)
.await
.unwrap();
thumbs
.create_thumbs("penguin.png", "/thumbs", false)
.await
.unwrap();
}
```
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Easy to use library to create image thumbnails from images existing on some (cloud) object
//! Easy-to-use library to create image thumbnails from images existing on some (cloud) object
//! storage or from disk.
//!
//! Currently implemented is a connection to Google Cloud Storage, but it can be easily extended to
Expand Down

0 comments on commit 30a0e92

Please sign in to comment.