Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API docs #87

Closed
sancarn opened this issue Sep 30, 2019 · 4 comments
Closed

API docs #87

sancarn opened this issue Sep 30, 2019 · 4 comments
Assignees
@s1hofmann
Labels
enhancement Enhancement to existing features
Milestone
v1.4.0

Comments

@sancarn
Copy link

sancarn commented Sep 30, 2019

Documentation would be helpful
@s1hofmann s1hofmann self-assigned this Oct 5, 2019
@s1hofmann s1hofmann added the enhancement Enhancement to existing features label Oct 5, 2019
@s1hofmann s1hofmann changed the title Documentation would be helpful API docs Oct 7, 2019
@s1hofmann
Copy link
Member

Hi @sancarn, thanks for reaching out!

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

s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) Screen API docs
ddeab54
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) Keyboard API docs
49bfa6d
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) Location API docs
ddc676b
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) LocationParameters API docs
f0cf782
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) Added typedoc and config
a483b36
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) Native provider interface docs
161d26c
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) VisionAdapter API docs
d7fa9d0
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) NativeAdapter API docs
f1c6e47
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) Generated API docs
fa788ce
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) Movement API docs
f6d8c6b
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) Generated API docs
7632947
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) Button API docs
bd6e262
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) Clipboard API docs
7dd4467
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) FileType API docs
1509fe1
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) generateOutputPath API docs
9b06ccc
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) Image API docs
cfdf9fe
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) Key API docs
10b0239
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) Updated keyboard samples
42a7c5f
s1hofmann added a commit that referenced this issue Oct 7, 2019
@s1hofmann
(#87) Mouse API docs
cc7ee90
@s1hofmann
Copy link
Member

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

s1hofmann added a commit that referenced this issue Mar 14, 2020
@s1hofmann
(#87) Merged latest develop
216ecfd
s1hofmann added a commit that referenced this issue Mar 14, 2020
@s1hofmann
(#87) Updated typedoc config
f086bf3
s1hofmann added a commit that referenced this issue Mar 14, 2020
@s1hofmann
(#87) Latest docs
fe4456e
@s1hofmann s1hofmann modified the milestone: 1.3.3 Mar 14, 2020
@s1hofmann s1hofmann added this to the 1.4.0 milestone Mar 16, 2020
s1hofmann added a commit that referenced this issue Apr 29, 2020
@s1hofmann
(#87) Updated API docs
ff7b4eb
s1hofmann added a commit that referenced this issue Apr 29, 2020
@s1hofmann
(#87) Updated readme to include usage with Electron
aaefd8d
s1hofmann added a commit that referenced this issue Apr 29, 2020
@s1hofmann
(#87) Updated readme to include snapshot release info
5b982a8
@sancarn
Copy link
Author

sancarn commented Apr 30, 2020 •
edited
Loading

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
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@s1hofmann s1hofmann

Labels
enhancement Enhancement to existing features
Projects
None yet
Milestone
v1.4.0
Development

No branches or pull requests
2 participants
@s1hofmann @sancarn