Skip to content

Commit 0394292

Browse files
committed
Cleaning up read me
1 parent 6ebcd41 commit 0394292

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,20 @@ A jQuery plugin that makes it easy to i18n your static web site.
1212
## Getting Started
1313
Download the [production version][min] or the [development version][max].
1414

15-
[min]: https://raw.github.com/jgolla/jquery-localize/master/dist/localize.min.js
16-
[max]: https://raw.github.com/jgolla/jquery-localize/master/dist/localize.js
15+
[min]: https://raw.github.com/jgolla/jquery-localize/master/dist/jquery.localize.min.js
16+
[max]: https://raw.github.com/jgolla/jquery-localize/master/dist/jquery.localize.js
1717

1818
### Load the jquery-localize plugin on your page.
1919

20-
It's the file located at `build/jquery.localize.js`
20+
It's the file located at `dist/jquery.localize.js`
2121

2222
### Mark up tags whose content you want to be translated
2323

2424
Somewhere in your html:
2525

26-
<h1 data-localize="greeting"> Hello! </h1>
26+
```html
27+
<h1 data-localize="greeting"> Hello! </h1>
28+
```
2729

2830
### Provide a JSON language file that has translations:
2931

@@ -94,13 +96,15 @@ If you rely on the default callback and use the "data-localize" attribute then t
9496

9597
**HTML:**
9698

97-
<p data-localize="title">Tracker Pro XT Deluxe</p>
98-
<p data-localize="search.placeholder">Search...</p>
99-
<p data-localize="search.button">Go!</p>
100-
<p data-localize="footer.disclaimer">Use at your own risk.</p>
101-
<p data-localize="menu.dashboard">Dashboard</p>
102-
<p data-localize="menu.list">Bug List</p>
103-
<p data-localize="menu.logout">Logout</p>
99+
```html
100+
<p data-localize="title">Tracker Pro XT Deluxe</p>
101+
<p data-localize="search.placeholder">Search...</p>
102+
<p data-localize="search.button">Go!</p>
103+
<p data-localize="footer.disclaimer">Use at your own risk.</p>
104+
<p data-localize="menu.dashboard">Dashboard</p>
105+
<p data-localize="menu.list">Bug List</p>
106+
<p data-localize="menu.logout">Logout</p>
107+
```
104108

105109
**application-es.json (fake spanish)**
106110

@@ -122,7 +126,11 @@ If you rely on the default callback and use the "data-localize" attribute then t
122126

123127
**Localize it!**
124128

125-
$("[data-localize]").localize("application", { language: "es" })
129+
```html
130+
<script>
131+
$("[data-localize]").localize("application", { language: "es" })
132+
</script>
133+
```
126134

127135
### Callbacks
128136

0 commit comments

Comments
 (0)