added examples to README.md

README.md

@@ -1,3 +1,67 @@
 # circuiteria
 
-Drawing block circuits with Typst made easy, using CeTZ
+Circuiteria is a [Typst](https://typst.app) package for drawing block circuit diagrams using the [CeTZ](https://typst.app/universe/package/cetz) package.
+
+<p align="center">
+  <img src="gallery/platypus.png" alt="Perry the platypus">
+</p>
+
+## Examples
+<table>
+  <tr>
+    <td colspan="2">
+      <a href="gallery/test.typ">
+        <img src="gallery/test.png" width="500px">
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td colspan="2">A bit of eveything</td>
+  </tr>
+  <tr>
+    <td colspan="2">
+      <a href="gallery/test5.typ">
+        <img src="gallery/test5.png" width="500px">
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td colspan="2">Wires everywhere</td>
+  </tr>
+  <tr>
+    <td>
+      <a href="gallery/test4.typ">
+        <img src="gallery/test4.png" width="250px">
+      </a>
+    </td>
+    <td>
+      <a href="gallery/test6.typ">
+        <img src="gallery/test6.png" width="250px">
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>Groups</td>
+    <td>Rotated</td>
+  </tr>
+</table>
+
+> **Note**\
+> These circuit layouts were copied from a digital design course given by prof. S. Zahno and recreated using this package
+
+*Click on the example image to jump to the code.*
+
+## Usage
+For information, see the [manual](manual.pdf)
+
+To use this package, simply import [src/lib.typ](src/lib.typ) and call the `circuit` function:
+```typ
+#import "src/lib.typ"
+#lib.circuit({
+  import lib: *
+  ...
+})
+```
+
+## Installing
+> TODO

gallery/platypus.typ

@@ -1,6 +1,6 @@
 #import "../src/lib.typ": *
 
-//#set page(width: auto, height: auto, margin: .5cm)
+#set page(width: auto, height: auto, margin: .5cm)
 
 #let teal = rgb(37, 155, 166)
 #let orange = rgb(254, 160, 93)