From 6ed1fdb3e675a6d13c258ad27b4fa5016267e0ca Mon Sep 17 00:00:00 2001
From: Yongwei Xing <yongwei.xing@liulishuo.com>
Date: Wed, 3 Mar 2021 13:24:54 +0800
Subject: [PATCH] update README

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e961a67..e45b137 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,40 @@
 # generativeart
-Generative Art in Go
+
+[![Go Report Card](https://goreportcard.com/badge/github.com/jdxyw/generativeart)](https://goreportcard.com/report/github.com/jdxyw/generativeart)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/jdxyw/generativeart/master/LICENSE)
+
+
+generativeart is a Go package to generate many kinds of generative art. Currently, it supports the following type.
+
+- Maze
+- Julia Set
+- Random Circle Trails
+- Silk Smoke
+- Spiral Square
+- Square Grid
+- Circle Line
+
+For these kinds of art, the package provides as many as parameters to control the appearance. 
+
+## Install
+
+```bash
+go get github.com/jdxyw/generativeart
+```
+
+## Usage and example
+
+## TODO
+
+- Add more kinds of generative arts or types.
+
+## Contribution
+
+Thanks for the following sites and repos, I got lots of ideas, inspiration, code and tricks from them. The list would be very long, sorry for forgetting some of them.
+
+- https://inconvergent.net/
+- https://fronkonstin.com/
+- https://github.com/aschinchon/cyclic-cellular-automata
+- https://github.com/armdz/ProcessingSketchs
+- https://github.com/Mr-Slesser/Generative-Art-And-Fractals
+- http://blog.dragonlab.de/2015/03/generative-art-week-1