Skip to content

docs: update README install steps (xcbeautify and init submodules) #44

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

Open
Rezisn wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: update README install steps (xcbeautify and init submodules) #44

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5cf1ef
docs: update docs to include xcbeautify and git submodule
Rezisn May 8, 2026
25101e9
docs: update example to use png
Rezisn May 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@ Control any iOS device or simulator over a simple JSON-RPC API. Tap, swipe, stre
git clone https://github.com/mobile-next/devicekit-ios.git
cd devicekit-ios

# Install dependencies
brew install xcbeautify

# Fetch git submodules
git submodule update --init --recursive

# Build unsigned IPA for real devices
make ipa-unsigned

Expand All @@ -74,7 +80,7 @@ Once the server is running at `127.0.0.1:12004`, make your first call:
```bash
curl -X POST http://127.0.0.1:12004/rpc \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"device.screenshot","params":{},"id":1}'
-d '{"jsonrpc":"2.0","method":"device.screenshot","params":{ "format": "png" },"id":1}'
Copy link
Copy Markdown
Author

@Rezisn Rezisn May 8, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

found that current implementation of device.screenshot (here) set format as mandatory parameters.

```

Returns a base64-encoded PNG of the current screen.
Expand Down