From 00cd11b5d5492beefa33827947aa201f743faa42 Mon Sep 17 00:00:00 2001
From: Siddharth Bhatia <32610387+Sid-Bhatia-0@users.noreply.github.com>
Date: Wed, 23 Jun 2021 15:45:13 +0530
Subject: [PATCH] update README (#9)
* update README
* add links to assets
---
README.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 71 insertions(+)
diff --git a/README.md b/README.md
index 753c8f3..7af94dd 100644
--- 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
+```
+
+
+
+### Circle
+
+```
+struct Circle{I <: Integer} <: AbstractShape
+ i_center::I
+ j_center::I
+ radius::I
+end
+```
+
+
+
+### FilledCircle
+
+```
+struct FilledCircle{I <: Integer} <: AbstractShape
+ i_center::I
+ j_center::I
+ radius::I
+end
+```
+
+
+
+### Rectangle
+
+```
+struct Rectangle{I <: Integer} <: AbstractShape
+ i_top_left::I
+ j_top_left::I
+ height::I
+ width::I
+end
+```
+
+
+
+### FilledRectangle
+
+```
+struct FilledRectangle{I <: Integer} <: AbstractShape
+ i_top_left::I
+ j_top_left::I
+ height::I
+ width::I
+end
+```
+
+