summaryrefslogtreecommitdiff
path: root/graphics/pgf/contrib/tikzducks/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/pgf/contrib/tikzducks/README.md')
-rw-r--r--graphics/pgf/contrib/tikzducks/README.md29
1 files changed, 24 insertions, 5 deletions
diff --git a/graphics/pgf/contrib/tikzducks/README.md b/graphics/pgf/contrib/tikzducks/README.md
index 248ed49d42..8298baafa7 100644
--- a/graphics/pgf/contrib/tikzducks/README.md
+++ b/graphics/pgf/contrib/tikzducks/README.md
@@ -1,11 +1,30 @@
+![](https://raw.githubusercontent.com/samcarter/tikzducks/main/ICON.png)
+
# TikZducks
-This is a little LaTeX package for ducks to be used in TikZ pictures. The project is a continuation of the TeX.Stackexchange.com answer [How can we draw a duck](https://tex.stackexchange.com/a/347458/36296)
+[![GitHub](https://img.shields.io/github/license/samcarter/tikzducks.svg?color=blue)](http://www.latex-project.org/lppl.txt)
+[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/samcarter/tikzducks.svg?label=current%20version)](https://github.com/samcarter/tikzducks/releases/latest)
+[![CTAN](https://img.shields.io/ctan/v/tikzducks.svg)](https://ctan.org/pkg/tikzducks)
+
+This is a little LaTeX package for ducks to be used in TikZ pictures.
+
+This project is licensed under the LaTeX Project Public License v1.3c or later, see http://www.latex-project.org/lppl.txt .
+
+The project repository, including a bug tracker, can be found at https://github.com/samcarter/tikzducks .
+
+### Usage
+
+```latex
+\documentclass{standalone}
+\usepackage{tikzducks}
-This project is licensed under the LaTeX Project Public License v1.3c or later, see http://www.latex-project.org/lppl.txt
+\begin{document}
-## A few examples:
+\begin{tikzpicture}
+ \duck
+\end{tikzpicture}
-![tikz ducks](https://user-images.githubusercontent.com/43832342/71718547-d160d400-2e1b-11ea-8bae-39cc4b648771.png)
+\end{document}
+```
-More examples of TikZducks can be seen at https://github.com/samcarter/tikzducks/ \ No newline at end of file
+For more details, please consult the [package documentation](https://github.com/samcarter/tikzducks/blob/main/DOCUMENTATION.pdf).