From c5cca3628de3050eddef76029265dc6fbe5af4c5 Mon Sep 17 00:00:00 2001 From: Isaiah Odhner Date: Tue, 15 Oct 2024 17:56:17 -0400 Subject: [PATCH] Make API.md into the README.md of the core package Getting ready for a release... https://github.com/1j01/tracky-mouse/issues/48 --- README.md | 2 +- API.md => core/README.md | 12 +++++++++++- website/index.html | 4 +++- 3 files changed, 15 insertions(+), 3 deletions(-) rename API.md => core/README.md (96%) diff --git a/README.md b/README.md index 453fa97..c965471 100644 --- a/README.md +++ b/README.md @@ -144,7 +144,7 @@ Tracky Mouse is available on npm: npm install tracky-mouse ``` -Read the [API documentation](./API.md) for more information. +Read the [API documentation](./core/README.md) for more information. ## Changelog diff --git a/API.md b/core/README.md similarity index 96% rename from API.md rename to core/README.md index 4a4385d..3f9a8a5 100644 --- a/API.md +++ b/core/README.md @@ -9,6 +9,8 @@ It includes a full user interface with a webcam view and settings, and the API l The dwell clicker can also work independently of the head tracking, for use with external pointing devices, including eye trackers (which require similar UI concerns), and the Tracky Mouse desktop app, which can control your computer's mouse. With the desktop app (also open source), users will be able to seamlessly upgrade to full computer control, without learning a new UI. +[✨👉 **Demo and more information on the Tracky Mouse website** 👈✨](https://trackymouse.js.org/) + ## Installation ```bash @@ -271,4 +273,12 @@ This stops the dwell clicker. ## Changelog -For release notes, see [CHANGELOG.md](CHANGELOG.md) +For release notes, see [CHANGELOG.md](https://github.com/1j01/tracky-mouse/blob/main/CHANGELOG.md) + +## License + +[MIT License](https://github.com/1j01/tracky-mouse/blob/main/LICENSE.txt) + +## Development + +See [Development Setup](https://github.com/1j01/tracky-mouse#development-setup) in the main README. diff --git a/website/index.html b/website/index.html index 413f3b6..8b538cb 100644 --- a/website/index.html +++ b/website/index.html @@ -244,7 +244,9 @@

Embed in your own web application

Check out the - API documentation + API + documentation + for more information.