Skip to content

armgit / xtool

Public Imported from GitHub
0

Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux, Windows, macOS.

More readme improvements

Kabir Oberaic248adb605a4
diff --git a/README.md b/README.md
index 585bd9c..4e945a0 100644
--- a/README.md
+++ b/README.md
@@ -12,16 +12,20 @@ xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functiona
✅ Interact with Apple Developer Services programmatically
-![A screenshot of xtool being invoked from VSCode](Sources/XTool/Documentation.docc/Resources/Cover.png)
-
## Getting Started
1. Follow the guide to install `xtool`
- - [Linux](#)
- - macOS: TBD
-2. Create and run your first xtool-powered app by following the [tutorial](#)
+ - [Installation (Linux)](#)
+ - Installation (macOS): TBD
+2. Create and run your first xtool-powered app by following the [tutorial](#)!
+
+## Examples
+
+### Screenshot
+
+![A screenshot of xtool being invoked from VSCode](Sources/XTool/Documentation.docc/Resources/Cover.png)
-## Use xtool via the command line
+### Command line interface
```bash
$ xtool --help
@@ -51,7 +55,7 @@ DEVICE SUBCOMMANDS:
See 'xtool help <subcommand>' for detailed help.
```
-## …or as a library!
+### Library
xtool includes a library that you can use to interact with Apple Developer Services, iOS devices, and more from your own app. You can use this by adding `XKit` as a SwiftPM dependency.