Skip to content

Commit

Permalink
Merge pull request #34 from willowtreeapps/release/1.0.2
Browse files Browse the repository at this point in the history
Prepare for 1.0.2 release
  • Loading branch information
nishtahir authored Apr 27, 2018
2 parents 34bfe80 + 623cd7f commit 8ffe8e6
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 9 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ Features:

## Project setup

You can install Ukor via NPM.

```sh
npm install -g @willowtreeapps/ukor
```

A Ukor project is organized in a single `src` folder with properties files in order to configure Ukor. The `src` folder contains a single `main` folder which contain the default built sources, optional customized flavor sources as well as test sources.

```
Expand Down Expand Up @@ -69,7 +75,7 @@ rokus: {
Each flavor can contain string resources specified in the `YAML` format by providing `constants.yaml` file. Strings can be referenced by their path specified in any `.xml` or `.brs` source files. For example,

Given a `constants.yaml` file:
```
```yml
strings:
contactSupport: 'contact support at 555-555-5555'
login:
Expand All @@ -78,20 +84,20 @@ strings:
Strings can be references in a `*.brs` file using the following interpolation syntax `@{ <your_resource_here> }`. For example,

```
```yml
supportLabel.text = "@{strings.contactSupport}"
loginLabel.text = "@{strings.login.signIn}"
```

The final generated `*.brs` source file will have the strings inlined like so.

```
```yml
supportLabel.text = "contact support at 555-555-555"
loginLabel.text = "Sign in now!"
```

## Usage
```
```sh
Usage: ukor [options] [command]
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ukor",
"version": "0.1.0",
"name": "@willowtreeapps/ukor",
"version": "1.0.2",
"description": "Roku build tool with flavors and deployment",
"keywords": [
"roku",
Expand All @@ -17,7 +17,12 @@
"scripts": {
"docs": "./build/run-docs.sh"
},
"author": "WillowTree Inc",
"repository": {
"type": "git",
"url": "https://github.com/willowtreeapps/ukor"
},
"author": "WillowTree Inc.",
"publisher": "willowtreeapps",
"license": "Apache-2.0",
"bin": {
"ukor": "bin/ukor.js"
Expand Down

0 comments on commit 8ffe8e6

Please sign in to comment.