Skip to content

Commit

Permalink
Doc improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
Xavier Hainaux committed Mar 21, 2013
1 parent cc08c8c commit e93d029
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 3 deletions.
4 changes: 3 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
samples/
tests/
tests/
doc/
.idea/
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@
Given a Google Spreadsheet like this:
![Spreadsheet example](doc/spreadsheet-example.png)

The tool fetch the spreadsheet and write the result to a file in the Android or iOS format:
![Result android](doc/result-android.png) ![Result iOS](doc/result-ios.png)

Create a file update-localization.js
var Gs2File = require("../index.js");
var Gs2File = require("localize-with-spreadsheet");

var transformer = Gs2File.fromGoogleSpreadsheet("0Aq6WlQdq71FydDZlaWdmMEUtc2tUb1k2cHRBS2hzd2c", '*');
transformer.setKeyCol('KEY');
Expand All @@ -22,3 +25,8 @@ Create a file update-localization.js
transformer.save("fr.lproj/Localizable.strings", { valueCol: "FR", format: "ios" });

## Advanced
You can filter the worksheets to include with the second parameter of 'fromGoogleSpreadsheet'
Ex:
Gs2File.fromGoogleSpreadsheet("<Key>", '*');
Gs2File.fromGoogleSpreadsheet("<Key>", ['HomeScreen, 'ContactScreen']);
Gs2File.fromGoogleSpreadsheet("<Key>", [0, 2]);
Binary file added doc/result-android.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/result-ios.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
},
"name": "localize-with-spreadsheet",
"description": "Create a localization file in Android or iOS format from a Google Spreadsheet",
"version": "0.1.0",
"version": "0.1.1",
"homepage": "https://github.com/xavierha/localize-with-spreadsheet",
"repository": {
"type": "git",
Expand Down

0 comments on commit e93d029

Please sign in to comment.