diff --git a/README.md b/README.md index 777b2ee..7f53f84 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,29 @@ python-localizable ================== Localizable.strings parser for Python + +# Usage + +Install using pip. + + $ pip install localizable + +You can either parse a full string directly or pass a file path: + + import localizable + + strings = localizable.parse_strings(filename='Localizable.strings') + strings = localizable.parse_strings(content="content of .strings file") # this works too + +The output format is an array of dictionaries, in order, with the following key/value pairs: + + /* Comment */ + "Key" = "Value"; + + * `key`: "Key" + * `value`: "Value" + * `comment`: "Comment" + +# License + +GPLv2. Adapted from Transifex. \ No newline at end of file