Merge pull request #9 from HarryChen0506/dev

docs: readme
HarryChen0506 · Feb 5, 2020 · 3a18a65 · 3a18a65
2 parents 973606a + 79b5209
commit 3a18a65
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,9 @@
+[Home](https://harrychen0506.github.io/malyan/) • 
+[Examples](https://harrychen0506.github.io/malyan/examples/) • 
+[Documentation](https://harrychen0506.github.io/malyan/docs/en/) • 
+[中文文档](https://harrychen0506.github.io/malyan/docs/cn/) • 
+[Help](https://github.com/HarryChen0506/malyan/issues?labels=question)
+
 Malyan
 ========
 
@@ -15,11 +21,7 @@ Malyan
 
  Malyan also provides an extensive event system, starting from low-level "mouse" events (click, mousedrag, mouseEnter, etc) to high-level objects ones (object:mousemove, object:mousedrag).
 
- [Home](https://harrychen0506.github.io/malyan/) • 
- [Examples](https://harrychen0506.github.io/malyan/examples/) • 
- [Documentation](https://harrychen0506.github.io/malyan/docs/en/) • 
- [中文文档](https://harrychen0506.github.io/malyan/docs/cn/) • 
- [Help](https://github.com/HarryChen0506/malyan/issues?labels=question)
+
 
 ### Usage ###
 
@@ -36,7 +38,7 @@ Malyan
   // CDN
   <script src="https://unpkg.com/malyan"></script>
   // or use a specific version/tag via URLs
-  <script src="https://unpkg.com/malyan@0.0.4/dist/malyan.min.js"></script>
+  <script src="https://unpkg.com/malyan@0.0.7/dist/malyan.min.js"></script>
 ```
 
   + Install with NPM

diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md
@@ -16,4 +16,4 @@
   * [BaseObject](api/index.md#baseobject)
   * [EventTarget](api/index.md#eventtarget)
   * [shapes](api/index.md#shapes)
-   - [rect](api/index.md#rect)
+   - [Rect](api/index.md#rect)
diff --git a/docs/en/api/index.md b/docs/en/api/index.md
@@ -208,6 +208,7 @@ type: api
 ---
 ### shapes
 #### Rect
+* **Extends:** [Shape](#shape)
 * **Construction:** `( params : Object ) `  
   Create a new instance of Vector.
   - **x:** `Number` the x-axis value of left-top vertex. Optional; defaults to `0`.