Skip to content

Commit 02792cf

Browse files
committed
Address comments from PR #47
1 parent 8a32971 commit 02792cf

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Published on npm](https://img.shields.io/npm/v/lit-localize.svg)](https://www.npmjs.com/package/lit-localize) [![Test Status](https://github.com/PolymerLabs/lit-localize/workflows/tests/badge.svg?branch=master)](https://github.com/PolymerLabs/lit-localize/actions?query=workflow%3Atests+branch%3Amaster+event%3Apush)
44

5-
<img src="./rgb_lit.png" height="100" align="right"></img>
5+
<img src="./rgb_lit.png" width="150" height="100" align="right"></img>
66

77
###### [API](#api) | [Tutorial](#tutorial) | [API](#api)
88

@@ -13,6 +13,7 @@
1313

1414
- 🌐 Localize your lit-html and LitElement applications
1515
- 🔥 Safely embed HTML markup within localized templates
16+
- 🍦 Write vanilla code that works in development with no new tooling
1617
- 📄 Standard XLIFF interchange format
1718
- 🆓 Generate a zero-overhead bundle for each locale
1819
- 🔁 ... or dynamically load locales and automatically re-render
@@ -54,6 +55,10 @@
5455
function. The first argument is a unique identifier for this template, and
5556
the second is a string or lit-html template.
5657

58+
(Note that this code will directly compile and run, just as it would if you
59+
were rendering the lit template directly, so your build process doesn't need
60+
to change until you want to integrate localized templates.)
61+
5762
```typescript
5863
import {html, render} from 'lit-html';
5964
import {msg} from 'lit-localize';
@@ -66,7 +71,8 @@
6671

6772
4. Make a JSON config file at the root of your project called
6873
`lit-localize.json`. In this example we're using _transform_ mode, but you
69-
can also use _runtime_ mode.
74+
can also use _runtime_ mode. The `$schema` property is optional, and lets
75+
editors like VSCode auto-complete and check for errors.
7076

7177
```json
7278
{

0 commit comments

Comments
 (0)