Update docs

README.md

@@ -1,12 +1,12 @@
 # encantar.js WebAR engine
 
-[![GitHub release (latest by date)](https://img.shields.io/github/v/release/alemart/encantar-js)](https://github.com/alemart/encantar-js/releases/) ![GitHub file size in bytes on a specified ref (branch/commit/tag)](https://img.shields.io/github/size/alemart/encantar-js/dist/encantar.min.js?branch=master&label=minified%20js) [![GitHub Repo stars](https://img.shields.io/github/stars/alemart/encantar-js?logo=github)](https://github.com/alemart/encantar-js/stargazers) [![GitHub Sponsors](https://img.shields.io/github/sponsors/alemart?logo=github)](https://github.com/sponsors/alemart/)
+![GitHub release](https://img.shields.io/github/v/release/alemart/encantar-js) ![GitHub file size](https://img.shields.io/github/size/alemart/encantar-js/dist/encantar.min.js?branch=master&label=minified%20js) [![GitHub Repo stars](https://img.shields.io/github/stars/alemart/encantar-js?logo=github)](https://github.com/alemart/encantar-js/stargazers) [![GitHub Sponsors](https://img.shields.io/github/sponsors/alemart?logo=github)](https://github.com/sponsors/alemart/) [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/alemart)
 
 The Augmented Reality engine that will enchant you!
 
-:magic_wand: **[Demos](https://alemart.github.io/encantar-js/demos/)** | :eyes: **[Try it!](https://alemart.github.io/encantar-js/demos/hello-three/poster.html)** | :books: **[Learn](https://alemart.github.io/encantar-js/)** | :heart: **[Support](https://alemart.github.io/encantar-js/support-my-work)**
+:star2: **[Try it!](https://alemart.github.io/encantar-js/demos/hello-three/poster.html)** | :video_game: **[Play a game!](https://alemart.github.io/encantar-js/demos/basketball/poster.html)** | :magic_wand: **[Demos](https://alemart.github.io/encantar-js/demos/)** | :books: **[Learn](https://alemart.github.io/encantar-js/)**
 
-[![Demo](docs/img/mage.gif)](https://alemart.github.io/encantar-js/demos/hello-three/poster.html)
+[![Demo](docs/img/mage.gif)](https://alemart.github.io/encantar-js/demos/hello-three/poster.html) [![Game](docs/img/basketball.gif)](https://alemart.github.io/encantar-js/demos/basketball/poster.html)
 
 ## Features
 

docs/api/camera-source.md

@@ -39,4 +39,4 @@ const webcam = AR.Source.Camera({
 
 `source.resolution: Resolution, read-only`
 
-The [resolution](resolution.md) of this source of data.
+The [resolution](resolution.md) of this source of data. Set it when [instantiating](#instantiation) the object.

docs/api/image-tracker.md

@@ -15,7 +15,7 @@ Instantiate an image tracker with the specified `options`.
 **Arguments**
 
 * `options: object, optional`. An object with the following keys (all are optional):
-    * `resolution: Resolution`. The [resolution](resolution.md) of the tracker. Make sure that the [resolution of the video](camera-source.md) is at least as high as this. Suggested values: `"sm"`, `"sm+"`, `"md"`, `"md+"`.
+    * `resolution: Resolution`. The [resolution](resolution.md) of the tracker. Make sure that the [resolution of the video](camera-source.md#resolution) is at least as high as this. Suggested values: `"sm"`, `"sm+"`, `"md"`, `"md+"`.
 
 **Returns**
 
@@ -29,11 +29,11 @@ const imageTracker = AR.Tracker.Image({
 });
 ```
 
-### ~~AR.Tracker.ImageTracker~~
+### AR.Tracker.ImageTracker
 
-~~`AR.Tracker.ImageTracker(): ImageTracker`~~
+<span style="text-decoration: line-through">`AR.Tracker.ImageTracker(): ImageTracker`</span>
 
-Instantiate an image tracker with default settings.
+Instantiate an image tracker with the default settings.
 
 *Deprecated since:* 0.4.0. Use `AR.Tracker.Image()` instead.
 
@@ -67,7 +67,7 @@ A [database](reference-image-database.md) of [reference images](reference-image.
 
 The [resolution](resolution.md) adopted by the computer vision algorithms implemented in the tracker. Higher resolutions improve the tracking quality, but are computationally more expensive. Note that this resolution is different from, and should not be larger than, the [resolution of the camera](camera-source.md#resolution)!
 
-*Note:* this property is read-only since 0.4.0. Set the resolution when instantiating the tracker.
+*Note:* this property is read-only since 0.4.0. Set the resolution when [instantiating](#instantiation) the tracker.
 
 ## Events
 

docs/api/resolution.md

@@ -1,6 +1,6 @@
 # Resolution
 
-A `Resolution` is a setting defined by a string. It is mapped to a size measured in pixels according to special rules. You may use it, for example, to change the resolution of a video captured by a webcam, to adjust the resolution of a video when it is processed by a tracker, or to set the rendering resolution of a virtual scene.
+A `Resolution` is a setting defined by a string. It is mapped to a size measured in pixels according to special rules. You may use it, for example, to set the [resolution of the camera](camera-source.md#resolution), to adjust the [resolution of the tracker](image-tracker.md#resolution), or to set the [rendering resolution](viewport.md#resolution) of the virtual scene.
 
 The table below shows examples of how resolution strings are converted to pixels:
 

docs/api/viewport.md

@@ -51,7 +51,7 @@ The [HUD](hud.md).
 
 `viewport.resolution: Resolution, read-only`
 
-The [resolution](resolution.md) of the virtual scene.
+The [resolution](resolution.md) of the virtual scene. You may set it when [instantiating](#instantiation) the viewport.
 
 ### aspectRatio
 

docs/index.md

@@ -1,12 +1,12 @@
 # Welcome to encantar.js!
 
-[![GitHub release (latest by date)](https://img.shields.io/github/v/release/alemart/encantar-js)](https://github.com/alemart/encantar-js/releases/) ![GitHub file size in bytes on a specified ref (branch/commit/tag)](https://img.shields.io/github/size/alemart/encantar-js/dist/encantar.min.js?branch=master&label=minified%20js) [![GitHub Repo stars](https://img.shields.io/github/stars/alemart/encantar-js?logo=github)](https://github.com/alemart/encantar-js/stargazers) [![GitHub Sponsors](https://img.shields.io/github/sponsors/alemart?logo=github)](https://github.com/sponsors/alemart/)
+![GitHub release](https://img.shields.io/github/v/release/alemart/encantar-js) ![GitHub file size](https://img.shields.io/github/size/alemart/encantar-js/dist/encantar.min.js?branch=master&label=minified%20js) [![GitHub Repo stars](https://img.shields.io/github/stars/alemart/encantar-js?logo=github)](https://github.com/alemart/encantar-js/stargazers) [![GitHub Sponsors](https://img.shields.io/github/sponsors/alemart?logo=github)](https://github.com/sponsors/alemart/) [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/alemart)
 
 The Augmented Reality engine that will enchant you!
 
-[:sparkles: Demos](./demos.md){ .md-button ._blank }
-[:eyes: Try it!](https://alemart.github.io/encantar-js/demos/hello-three/poster.html){ .md-button ._blank }
-[:books: Learn](./tutorial/introduction.md){ .md-button } [:heart:{ .heart } Support](./support-my-work.md){ .md-button }
+[:star2: Try it!](./demos/hello-three/poster.html){ .md-button ._blank } [:video_game: Play a game!](./demos/basketball/poster.html){ .md-button ._blank } [:sparkles: Demos](./demos.md){ .md-button ._blank } [:books: Learn](./tutorial/introduction.md){ .md-button }
+
+[![Demo](./img/mage.gif)](./demos/hello-three/poster.html){ ._blank } [![Game](./img/basketball.gif)](./demos/basketball/poster.html){ ._blank }
 
 ## Features
 

docs_overrides/js/extra.js

@@ -17,11 +17,11 @@ document.addEventListener('DOMContentLoaded', () => {
 
     const support = document.createElement('a');
     const heart = document.createElement('img');
-    const text = document.createTextNode('Support me');
+    const text = document.createTextNode('Support');
 
     heart.src = 'https://github.githubassets.com/images/icons/emoji/unicode/2764.png';
     heart.style.width = '24px';
-    heart.style.paddingRight = '8px';
+    //heart.style.paddingRight = '8px';
     heart.classList.add('gemoji', 'heart');
 
     support.href = 'https://alemart.github.io/encantar-js/support-my-work';
@@ -32,8 +32,8 @@ document.addEventListener('DOMContentLoaded', () => {
     support.style.position = 'fixed';
     support.style.right = '16px';
     support.style.bottom = '16px';
-    support.style.padding = '0 20px';
-    support.style.height = '48px';
+    support.style.padding = '12px';// '0 20px';
+    //support.style.height = '48px';
     support.style.color = 'var(--md-primary-fg-color)';
     support.style.backgroundColor = 'var(--md-primary-bg-color)';
     support.style.fontWeight = 'bold';
@@ -59,7 +59,7 @@ document.addEventListener('DOMContentLoaded', () => {
     });
 
     support.appendChild(heart);
-    support.appendChild(text);
+    //support.appendChild(text);
     document.body.appendChild(support);
 
 });

docs_overrides/support-my-work.html

@@ -2,10 +2,10 @@
 <html>
     <head>
         <meta charset="utf-8">
-        <meta http-equiv="refresh" content="0; url='https://alemart.github.io/demos/assets/promo.html'">
+        <meta http-equiv="refresh" content="0; url='https://alemart.github.io/encantar-js/demos/assets/promo.html'">
         <title>encantar.js - Support my work</title>
     </head>
     <body>
-        <p>Redirecting...</p>
+        <p><a href="https://alemart.github.io/encantar-js/demos/assets/promo.html">Redirecting...</a></p>
     </body>
 </html>