diff --git a/README.md b/README.md index 7ed80e7..7e0eddf 100644 --- a/README.md +++ b/README.md @@ -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. ``` @@ -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: @@ -78,20 +84,20 @@ strings: Strings can be references in a `*.brs` file using the following interpolation syntax `@{ }`. 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] diff --git a/package-lock.json b/package-lock.json index fd52911..fc243c3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { - "name": "ukor", - "version": "0.1.0", + "name": "@willowtreeapps/ukor", + "version": "1.0.2", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 80793f8..8dc6975 100644 --- a/package.json +++ b/package.json @@ -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", @@ -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"