Skip to content

Commit 96888c8

Browse files
committed
docs: update README for release
1 parent a299c64 commit 96888c8

File tree

2 files changed

+23
-6
lines changed

2 files changed

+23
-6
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,33 @@
11
[![npm version](https://badge.fury.io/js/%40novyk%2Fngxe.svg)](https://www.npmjs.com/@novyk/ngxe)
22
![CI](https://github.com/navix/ngxe/actions/workflows/ci.yml/badge.svg)
33

4-
# 📜 ngxe (currently in BETA)
4+
# 📜 ngxe
55

66
Angular 11.1+ JSON Translations Editor.
77

8+
A simple UI for your translations: hosted on NPM, runs on your dev machine.
9+
10+
### Features
11+
12+
* Works directly with your files, no additional routine.
13+
* Any number of locales.
14+
* Diff changes.
15+
* Filters, handy pagination.
16+
* Suggestions based on similar sources.
17+
* Themes: light, solarized, dark.
18+
19+
### [The front app demo — ngxe.oleksanovyk.com](https://ngxe.oleksanovyk.com/)
20+
21+
![ngxe screenshop](./screenshot.png)
22+
23+
824
## Installation
925

1026
```
11-
$ npm i @novyk/ngxe@beta -D
27+
$ npm i @novyk/ngxe -D
1228
```
1329

30+
1431
## Usage
1532

1633
#### Create `ngxe.json` config file in the root:
@@ -32,16 +49,16 @@ $ npm i @novyk/ngxe@beta -D
3249
```
3350

3451
* `input` - file generated by Angular, you can add it to `.gitignore`
35-
* `output.source` - copy of the input file but ordered by keys (need for further transitions and smooth committing to Git).
52+
* `output.source` - copy of the input file, but ordered by keys (need for further transitions and smooth committing to Git).
3653
* `output.translations` - target locales.
3754

3855
#### Extract translations from your project in JSON format:
3956

4057
```
41-
$ ng xi18n --format=json
58+
$ ng extract-i18n --format=json
4259
```
4360

44-
Editor works best if i18n messages have IDs:
61+
The editor works best if i18n messages have IDs, but it is not necessary:
4562

4663
```
4764
<div i18n="@@MSG_ID">Message with ID</div>
@@ -55,7 +72,7 @@ $localize`:@@MSG_ID_2:Message with ID 2`;
5572
$ npx ngxe
5673
```
5774

58-
Browser should open the app (http://localhost:7600/ngxe/index.html).
75+
Browser should open the app (http://localhost:7600/).
5976

6077
Use the ngxe app to update messages and press `Save Project` (all `output` files will be updated).
6178

screenshot.png

132 KB
Loading

0 commit comments

Comments
 (0)