API docs

[sancarn]

Documentation would be helpful

[s1hofmann]

Hi @sancarn, thanks for reaching out!

I'll start by adding API docs with proper explanation and samples.

[s1hofmann]

Docs generated via typedoc can be found here.
Will be updated gradually

[sancarn]

Hi @s1hofmann
Great work! Much better than last time I looked at this project and thanks for closing the issue as I wouldn't have seen it otherwise :)

Would be nice to add some simple samples of:

• Copy and Paste text
• Retrieve the region of a process window
• the screen module as a whole (find on screen, waitFor, and listeners)

EDIT:
Scratch that! I see you've made nut-tree/trailmix

I would suggest moving the Examples title directly underneath the first sample. Otherwise this is great! Thanks so much for all your hard work!

[s1hofmann]

Hi @sancarn,

thanks for the kind words!
There will be an update in https://github.com/nut-tree/trailmix soon which covers usage with Electron.
I’ll consider moving the samples to a more prominent position!

Thanks for reaching out!

Best regards

Simon