Skip to content

Commit

Permalink
Prepare 0.1.1:
Browse files Browse the repository at this point in the history
- lib - update docs by adding the screenshots
  • Loading branch information
elpiel committed Jun 24, 2022
1 parent 81de449 commit 1f8bc81
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "embedded-canvas"
version = "0.2.0-pre"
version = "0.1.1"
authors = ["Lechev.space <dev@lechev.space>", "Lachezar Lechev"]
description = "Draw anything with ease on the Canvas before drawing it to your small hardware display"
categories = ["embedded", "no-std"]
Expand Down
13 changes: 13 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,25 @@
//! The main advantages of the canvases in this crate are:
//!
//! 1. **Transparency** - pixels that haven't been drawn, won't override pixels on the display.
//!
//! ![Example: Transparency][transparency_screenshot]
//!
//!_Example: Transparency - The canvas content (a circle) is drawn on the display where
//! there's already a drawn square._
//!
//! 2. **Cropping** - The ability to crop leaves only the part of the canvas you want to
//! draw on the display. This is especially useful when you want to
//! partially show text, figures and images.
//!
//! ![Example: Cropping text][cropping_text_screenshot]
//!
//! _Example: Cropping text - The full canvas content is drawn on the left and
//! only portion of it is cropped and drawn on the right._
//!
//! [`embedded-graphics`]: https://crates.io/crates/embedded-graphics
//! [`embedded-graphics-core`]: https://crates.io/crates/embedded-graphics-core
//! [transparency_screenshot]: https://github.com/LechevSpace/embedded-canvas/raw/81de4494c36d0d76c552823b83d3ac446b27b636/examples/screenshots/transparency.png
//! [cropping_text_screenshot]: https://github.com/LechevSpace/embedded-canvas/raw/81de4494c36d0d76c552823b83d3ac446b27b636/examples/screenshots/cropping_text.png
//!
//! # How to work with canvases
//!
Expand Down

0 comments on commit 1f8bc81

Please sign in to comment.