From 765a5d494fd7bc3c03c5710ffb9ee284b6594c4f Mon Sep 17 00:00:00 2001 From: Julien Guerinet Date: Sat, 17 Nov 2018 16:32:47 -0500 Subject: [PATCH] Update README --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5e7ed8f..ace0c09 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -# String Parser +# Weave ## Summary -The String Parser takes an online CSV file and parses the content to produce the Strings files for an Android or iOS app. +Weave takes an online CSV file and parses the content to produce the Strings files for an Android or iOS app. +It can also parse Analytics events and screens to ensure that you are using the same properties cross platform. It also parses the Strings for Web in the form of a JSON: an on object with a bunch of key-value pairs, the key being the String key and the value being the translated String for that language. It will also show any warnings or errors that the Strings file might have. Please note that it assumes that the file is in UTF-8 and also produces UTF-8 files. @@ -9,8 +10,8 @@ Please note that it assumes that the file is in UTF-8 and also produces UTF-8 fi ## Instructions To use this: -* Download the latest jar from the releases tab and the [sample config](sample-config.txt) -* Set up your config file (follow the instructions in sample-config.txt) +* Download the latest jar from the releases tab and the [sample config](weave-config.json) +* Set up your config file (fill out the fields in the config) * There should be at least one column with the 'key' to represent the String keys * Any columns containing translations in your CSV file must have a header with the 2 character language Id (ex: en, fr) * You may also add a 'platforms' column and put in a CSV list of the platforms that a particular String should be parsed for. If the column doesn't exist or the platform value is empty for a specific String it will be parsed for all platforms @@ -21,8 +22,14 @@ For example, if you put ### General ### (or ### General), it will be parsed as ` like this for multiple: %1$s, %2$s... * Run the jar +For the analytics: +* Fill out the same sample config +* This will generate an `object` on Android / `class` on iOS / Json object on Web. +Within this object, there will be an `Event` and `Screen` `object`/`enum`/object. The key will be used as variable names (capitalized on mobile), and the tag will be the value. + ## Gradle Dependencies * [OkHttp](http://square.github.io/okhttp/) +* [kotlinx-serialization](https://github.com/Kotlin/kotlinx.serialization) * [super-csv](http://super-csv.github.io/super-csv/) ## Contributors @@ -34,7 +41,7 @@ like this for multiple: %1$s, %2$s... See the [Change Log](CHANGELOG.md). ## Copyright - Copyright 2013-2017 Julien Guerinet + Copyright 2013-2018 Julien Guerinet Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.