浏览代码

Update README

customisations
alemart 2 周前
父节点
当前提交
def00358d1
共有 1 个文件被更改,包括 19 次插入12 次删除
  1. 19
    12
      README.md

+ 19
- 12
README.md 查看文件

@@ -6,19 +6,32 @@ encantar.js is a GPU-accelerated Augmented Reality framework for the web.
6 6
 * It can run in devices without native support for AR / WebXR
7 7
 * It's **blazing fast**, built with GPU acceleration at its core
8 8
 * It's **easy to use** for developers and artists alike
9
+* It's **libre**: no vendor lock-in and no usage limits
9 10
 * **All you need is a modern web browser** - no app required!
10 11
 
11 12
 Get started at <https://encantar.dev> :magic_wand:
12 13
 
14
+**Enjoy my magic?** :mage_man:
15
+
16
+[![Donate via Ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J41O00K)
17
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/alemart?logo=github&style=for-the-badge)](https://github.com/sponsors/alemart)
18
+
13 19
 ## Demos
14 20
 
21
+Select any picture below, or [browse the website](https://encantar.dev/demos) for more!
22
+
15 23
 <a href="https://alemart.github.io/encantar-js/demos/hello-aframe/poster.html" target="_blank"><img src="docs/img/mage.gif" alt="Demo" height="144"></a> <a href="https://alemart.github.io/encantar-js/demos/basketball/poster.html" target="_blank"><img src="docs/img/basketball.gif" alt="Game" height="144"></a> <a href="https://alemart.github.io/encantar-js/addons/" target="_blank"><img src="docs/img/video-player.gif" alt="Video Player" height="144"></a>
16 24
 
17
-[More at the website...](https://encantar.dev/demos)
25
+## Documentation
26
+
27
+Learn the incantations:
28
+
29
+* [Tutorial for aspiring wizards](https://encantar.dev/tutorial)
30
+* [API Spellbook](https://encantar.dev/api)
18 31
 
19 32
 ## Core features
20 33
 
21
-Core features with [rich documentation](https://encantar.dev/api):
34
+Core incantations:
22 35
 
23 36
 * **Image tracking**: track detailed images such as cartoons or photos. Import your [custom images](https://encantar.dev/guidelines-for-images) and it just works!
24 37
 * **Pointer tracking**: create interactive experiences based on touch and mouse input with an easy-to-use API.
@@ -26,17 +39,11 @@ Core features with [rich documentation](https://encantar.dev/api):
26 39
 
27 40
 ## Add-Ons
28 41
 
29
-Additional features [available for supporters](https://encantar.dev/addons):
42
+[Extra incantations](https://encantar.dev/addons):
30 43
 
31
-* **Video Player**: easy-to-use video player with controls - suitable for promotional materials, educational content, interactive art, and much more. [Read more...](https://encantar.dev/addons/ar-video-player)
32
-* **Buttons & Clickables**: easily trigger reactions when buttons or 3D objects are tapped in AR. [Read more...](https://encantar.dev/addons/ar-button)
44
+* **Video Player**: easy-to-use video player with controls - suitable for promotional materials, educational content, interactive art, and much more.
45
+* **Buttons & Clickables**: easily trigger reactions when buttons or 3D objects are tapped in AR.
33 46
 
34 47
 ## About
35 48
 
36
-encantar.js is developed by [Alexandre Martins](https://github.com/alemart) and released under the [GNU LGPL v3](LICENSE.md). It's based on [speedy-vision](https://github.com/alemart/speedy-vision).
37
-
38
-**Enjoy my magic?** :mage_man:
39
-
40
-[![Donate via Ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J41O00K)
41
-[![GitHub Sponsors](https://img.shields.io/github/sponsors/alemart?logo=github&style=for-the-badge)](https://github.com/sponsors/alemart)
42
-
49
+encantar.js is developed by [Alexandre Martins](https://github.com/alemart) and released under the [GNU LGPL v3](LICENSE.md). It's based on [speedy-vision](https://github.com/alemart/speedy-vision), a computer vision library for JavaScript created by the same author.

正在加载...
取消
保存