Merge pull request #8 from xtool-org/update-readme

Better readme

Author: kabiroberai

README.md

@@ -12,20 +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](Assets/Screenshot.png)
+## Getting Started
 
-## Usage
+View the documentation on [Swift Package Index](https://swiftpackageindex.com/xtool-org/xtool).
 
-- xtool works out of the box on macOS.
-- On Linux, you'll need the development packages of [libimobiledevice](https://github.com/libimobiledevice/libimobiledevice) + its dependencies.
-  - Alternatively, we provide a Dockerfile that does this for you. See [Linux/README.md](/Linux/README.md).
+## Examples
 
-## Installation (CLI)
+### Screenshot
+
+![A screenshot of xtool being invoked from VSCode](Sources/XTool/Documentation.docc/Resources/Cover.png)
+
+### Command line interface
 
 ```bash
-$ git clone https://github.com/xtool-org/xtool
-$ cd xtool
-$ swift run xtool --help
+$ xtool --help
 OVERVIEW: Cross-platform Xcode replacement
 
 USAGE: xtool <subcommand>
@@ -52,7 +52,7 @@ DEVICE SUBCOMMANDS:
   See 'xtool help <subcommand>' for detailed help.
 ```
 
-## Installation (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.
 

Sources/XTool/Documentation.docc/Documentation.md

@@ -1,15 +1,18 @@
 # ``xtool``
 
-The `xtool` command line interface (CLI).
+Cross-platform Xcode replacement.
 
 ## Overview
 
-You can use `xtool` to interact with iOS applications and Apple Developer Services, including
+xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functionality with open standards.
 
-- Building a Swift Package into an iOS app on **macOS or Linux**.
-- Managing Codesigning Certificates, Devices, App Identifiers, and Provisioning Profiles across both free and paid Apple Developer accounts.
-- Codesigning a `.ipa`.
-- Installing a `.ipa` on your iOS device.
+✅ Build a SwiftPM package into an iOS app
+
+✅ Sign and install iOS apps
+
+✅ Interact with Apple Developer Services programmatically
+
+![A screenshot of xtool being invoked from VSCode](Cover.png)
 
 ## Topics