diff --git a/README.md b/README.md
index 4fea869..b7108c8 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
# {gex}
-[](https://www.repostatus.org/#active)
+[](https://www.repostatus.org/#inactive)
[](https://github.com/matt-dray/gex/actions/workflows/R-CMD-check.yaml)
[](https://www.rostrum.blog/index.html#category=gex)
@@ -50,9 +50,9 @@ It's up to the user to read their own images (via {[png](https://cran.r-project.
Below is an extremely basic example.
Note how you call each function independently, much like writing base plots.
-``` r
+```r
# Somewhere to save it
-temp_path <- tempfile(fileext = ".png")
+temp_path <- "~/Desktop/hexbase.png"
# Bring your own image
image_path <- system.file("img", "Rlogo.png", package = "png")
@@ -63,7 +63,7 @@ gex::open_device(
file_path = temp_path,
resolution = 300 # ppi, you can increase this
)
-gex::add_hex(col = "#BEBEBE") # named or hexadecimal
+gex::add_hex(col = "bisque") # named or hexadecimal
gex::add_image(
img = image_png,
y = 0.6, # 0 to 1 on x and y axes
@@ -72,27 +72,36 @@ gex::add_image(
)
gex::add_text(
string = "example",
+ x = 0.495,
y = 0.35,
+ col = "#000000",
+ family = "Comic Sans MS", # bring your own font
+ face = "bold"
+)
+gex::add_text(
+ string = "example",
+ x = 0.505,
+ y = 0.34,
col = "red",
- family = "mono", # bring your own font
- face = "bold.italic"
+ family = "Comic Sans MS",
+ face = "bold"
)
gex::add_text( # add multiple text and images
- string = "visit https://rstats.lol/ ftw",
+ string = "visit rostrum.blog ftw",
x = 0.73,
- y = 0.17,
- angle = 30,
- size = 6,
+ y = 0.18,
+ angle = 30, # rotate to match lower-right edge
+ size = 5, # point size
col = "blue",
- family = "serif"
+ family = "Papyrus"
)
-gex::add_border(col = "grey20")
+gex::add_border(col = "hotpink3")
gex::close_device() # writes to file
```
That creates this absolutely stunning demo sticker, written to the specified `file_path`:
-
+
Note that you can't rely on plot-window previews when you're developing your sticker (they lie).
You must inspect the generated PNG file instead.
diff --git a/man/figures/example.png b/man/figures/example.png
index 4bf47b1..7feacac 100644
Binary files a/man/figures/example.png and b/man/figures/example.png differ