update README (#9)

* update README * add links to assets
Sid-Bhatia-0 · Jun 23, 2021 · 00cd11b · 00cd11b · Sid-Bhatia-0 · Jun 23, 2021
1 parent 90e8d17
commit 00cd11b
Showing 1 changed file with 71 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,72 @@
 # SimpleDraw
+
+This package provides fast drawing methods for the following simple shapes:
+
+1. Line
+1. Circle
+1. FilledCircle
+1. Rectangle
+1. FilledRectangle
+
+### Line
+
+```
+struct Line{I <: Integer} <: AbstractShape
+    i1::I
+    j1::I
+    i2::I
+    j2::I
+end
+```
+
+<img src="https://user-images.githubusercontent.com/32610387/123078332-7d471680-d438-11eb-9216-0f0b41efdbd6.png">
+
+### Circle
+
+```
+struct Circle{I <: Integer} <: AbstractShape
+    i_center::I
+    j_center::I
+    radius::I
+end
+```
+
+<img src="https://user-images.githubusercontent.com/32610387/123078423-95b73100-d438-11eb-8329-546982bbb00c.png">
+
+### FilledCircle
+
+```
+struct FilledCircle{I <: Integer} <: AbstractShape
+    i_center::I
+    j_center::I
+    radius::I
+end
+```
+
+<img src="https://user-images.githubusercontent.com/32610387/123078474-a2d42000-d438-11eb-88cf-d0635380a21f.png">
+
+### Rectangle
+
+```
+struct Rectangle{I <: Integer} <: AbstractShape
+    i_top_left::I
+    j_top_left::I
+    height::I
+    width::I
+end
+```
+
+<img src="https://user-images.githubusercontent.com/32610387/123078509-ac5d8800-d438-11eb-814f-b7fa32857878.png">
+
+### FilledRectangle
+
+```
+struct FilledRectangle{I <: Integer} <: AbstractShape
+    i_top_left::I
+    j_top_left::I
+    height::I
+    width::I
+end
+```
+
+<img src="https://user-images.githubusercontent.com/32610387/123078547-b67f8680-d438-11eb-94be-af77c473d0e9.png">