summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Nikias Bassen2023-01-08 21:33:48 +0100
committerGravatar Nikias Bassen2023-01-08 21:33:48 +0100
commitb2b9943fc0456d8184d29d2e7f95de2609f907f6 (patch)
tree5176b0d7c25d972749c081e37825fb38ed3dd1d1 /README.md
parente212eb6ed1b1a6fb4d71c1ac8a687ea017d60ad5 (diff)
downloadlibplist-b2b9943fc0456d8184d29d2e7f95de2609f907f6.tar.gz
libplist-b2b9943fc0456d8184d29d2e7f95de2609f907f6.tar.bz2
Updated README
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 14 insertions, 7 deletions
diff --git a/README.md b/README.md
index e26e205..b21cc9c 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,18 @@
1# libplist 1# libplist
2 2
3*A small portable C library to handle Apple Property List files in binary or XML 3*A small portable C library to handle Apple Property List files in binary, XML,
4format.* 4JSON, or OpenStep format.*
5 5
6![](https://github.com/libimobiledevice/libplist/workflows/build/badge.svg) 6![](https://github.com/libimobiledevice/libplist/workflows/build/badge.svg)
7 7
8## Features 8## Features
9 9
10The project provides an interface to read and write plist files in binary or 10The project provides an interface to read and write plist files in binary,
11XML format alongside a command-line utility named `plistutil`. 11XML, JSON, or OpenStep format alongside a command-line utility named `plistutil`.
12 12
13Some key features are: 13Some key features are:
14 14
15- **Formats:** Supports binary and XML format 15- **Formats:** Supports binary, XML, JSON, and OpenStep format
16- **Utility:** Provides a `plistutil` utility for the command-line 16- **Utility:** Provides a `plistutil` utility for the command-line
17- **Python:** Provides Cython based bindings for Python 17- **Python:** Provides Cython based bindings for Python
18- **Tested:** Uses fuzzing and data compliance tests 18- **Tested:** Uses fuzzing and data compliance tests
@@ -59,10 +59,17 @@ Then simply run:
59```shell 59```shell
60plistutil -i foobar.plist -o output.plist 60plistutil -i foobar.plist -o output.plist
61``` 61```
62
63This converts the `foobar.plist` file to the opposite format, e.g. binary to 62This converts the `foobar.plist` file to the opposite format, e.g. binary to
64XML or vice versa, and outputs it to the `output.plist` file. 63XML or vice versa, and outputs it to the `output.plist` file.
65 64
65To convert to a specific format - and also to convert from JSON or OpenStep
66format - use the `-f` command line switch:
67```shell
68plistutil -i input.plist -f json
69```
70This will convert input.plist, regardless of the input format, to JSON. The
71code auto-detects the input format and parses it accordingly.
72
66Please consult the usage information or manual page for a full documentation of 73Please consult the usage information or manual page for a full documentation of
67available command line options: 74available command line options:
68```shell 75```shell
@@ -111,4 +118,4 @@ iPadOS, tvOS, watchOS, and macOS are trademarks of Apple Inc.
111This project is an independent software library and has not been authorized, 118This project is an independent software library and has not been authorized,
112sponsored, or otherwise approved by Apple Inc. 119sponsored, or otherwise approved by Apple Inc.
113 120
114README Updated on: 2020-06-12 121README Updated on: 2023-01-08