Skip to content

Commit

Permalink
Make API.md into the README.md of the core package
Browse files Browse the repository at this point in the history
Getting ready for a release...
#48
  • Loading branch information
1j01 committed Oct 15, 2024
1 parent 0362894 commit c5cca36
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 11 additions & 1 deletion API.md → core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
4 changes: 3 additions & 1 deletion website/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,9 @@ <h2>Embed in your own web application</h2>
</p>
<p>
Check out the
<a href="https://github.com/1j01/tracky-mouse/blob/main/API.md#tracky-mouse-api">API documentation</a>
<a href="https://github.com/1j01/tracky-mouse/blob/main/core/README.md#tracky-mouse-api">API
documentation</a>
<!-- <a href="https://www.npmjs.com/package/tracky-mouse">API documentation</a> -->
for more information.
</p>
<p>
Expand Down

0 comments on commit c5cca36

Please sign in to comment.