bug fixing in animations and adding Geometric Objects

README.md

@@ -1,12 +1,17 @@
-# p5.teach.js
+# p5.teach.js 
+
+<img src="assets/p5-astrik-teach.png" alt="astrik-logo" />
+
+> A beginner friendly math animation library for p5.js
 
 p5.teach.js provides tools for teaching through p5.js, such as functions to animate text, TeX, and shapes.
 
 ## Get Started
 
 ## Documentation
 
-- [API Reference](api_reference.md)
+- [TypeDoc Documentation](https://two-ticks.github.io/p5.teach.js/docs/index.html)
+- [API Reference](https://two-ticks.github.io/p5.teach.js/api_reference.md)
 - [Example Sketches](https://editor.p5js.org/radium.scientist/collections/-xxYz8cof)
 
 ## Setting up the development environment
@@ -17,6 +22,11 @@ p5.teach.js provides tools for teaching through p5.js, such as functions to anim
 4. As the code is updated, the final js file is updated in `dist/p5.teach.js` dynamically
 5. The sketch in the `index.html` file is reflected with the changes
 
+## Generating documentation
+
+1. We use `TypeDoc` 
+2. Run `yarn typedoc src` for generating docs
+
 ## Tests
 
 1. We use `jest` for testing