Skip to content

Commit d4803e4

Browse files
author
Nikos Vasileiou
authored
Merge pull request #133 from transifex/update-i18n-readme
Update package.json description and READMEs
2 parents d7223fa + ae92fac commit d4803e4

19 files changed

Lines changed: 245 additions & 24 deletions

File tree

‎.github/workflows/npm-publish.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
22
# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
33

4-
name: Node.js Package
4+
name: Build
55

66
on:
77
release:

‎.github/workflows/run-tests.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
22
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
33

4-
name: Node.js tests
4+
name: Test
55

66
on:
77
pull_request:

‎README.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
[![Build Status](https://travis-ci.org/transifex/transifex-javascript.svg?branch=master)](https://travis-ci.org/transifex/transifex-javascript)
2-
3-
41
# Transifex Javascript Toolkit
52

63
Transifex Javascript Toolkit is a collection of tools to easily localize your Javascript applications using [Transifex Native](https://www.transifex.com/native/).

‎packages/angular/package.json‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
{
22
"name": "@transifex/angular-projects",
33
"version": "3.2.1",
4-
"description": "Transifex Native for Angular",
4+
"description": "i18n Angular framework using Transifex Native",
55
"keywords": [
66
"transifex",
77
"i18n",
88
"l10n",
99
"localization",
10+
"internationalization",
11+
"globalization",
12+
"translation",
1013
"angular"
1114
],
1215
"author": "Transifex",

‎packages/angular/projects/tx-native-angular-sdk/README.md‎

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,22 @@
1-
# Transifex Native for Angular
1+
<p align="center">
2+
<a href="https://www.transifex.com">
3+
<img src="https://raw.githubusercontent.com/transifex/transifex-javascript/master/media/transifex.png" height="60">
4+
</a>
5+
</p>
6+
<p align="center">
7+
<i>Transifex Native is a full end-to-end, cloud-based localization stack for moderns apps.</i>
8+
</p>
9+
<p align="center">
10+
<img src="https://github.com/transifex/transifex-javascript/actions/workflows/npm-publish.yml/badge.svg">
11+
<a href="https://www.npmjs.com/package/@transifex/angular">
12+
<img src="https://img.shields.io/npm/v/@transifex/angular.svg">
13+
</a>
14+
<a href="https://developers.transifex.com/docs/native">
15+
<img src="https://img.shields.io/badge/docs-transifex.com-blue">
16+
</a>
17+
</p>
18+
19+
# Transifex Native SDK: Angular i18n
220

321
Angular library for localizing Angular application using
422
[Transifex Native](https://www.transifex.com/native/).
@@ -9,6 +27,22 @@ Related packages:
927

1028
Learn more about Transifex Native in the [Transifex Developer Hub](https://developers.transifex.com/docs/native).
1129

30+
# How it works
31+
32+
**Step1**: Create a Transifex Native project in [Transifex](https://www.transifex.com).
33+
34+
**Step2**: Grab credentials.
35+
36+
**Step3**: Internationalize the code using the SDK.
37+
38+
**Step4**: Push source phrases using the `@transifex/cli` tool.
39+
40+
**Step5**: Translate the app using over-the-air updates.
41+
42+
No translation files required.
43+
44+
![native](https://raw.githubusercontent.com/transifex/transifex-javascript/master/media/native.gif)
45+
1246
## Upgrade to v2
1347

1448
If you are upgrading from the `1.x.x` version, please read this [migration guide](https://github.com/transifex/transifex-javascript/blob/HEAD/UPGRADE_TO_V2.md), as there are breaking changes in place.

‎packages/angular/projects/tx-native-angular-sdk/package.json‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
{
22
"name": "@transifex/angular",
33
"version": "3.2.1",
4-
"description": "Transifex Native for Angular",
4+
"description": "i18n Angular framework using Transifex Native",
55
"keywords": [
66
"transifex",
77
"i18n",
88
"l10n",
99
"localization",
10+
"internationalization",
11+
"globalization",
12+
"translation",
1013
"angular"
1114
],
1215
"author": "Transifex",

‎packages/api/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# Transifex API JavaScript SDK
2+
3+
![example workflow](https://github.com/transifex/transifex-javascript/actions/workflows/npm-publish.yml/badge.svg)
4+
[![npm version](https://img.shields.io/npm/v/@transifex/api.svg)](https://www.npmjs.com/package/@transifex/api)
5+
[![documentation](https://img.shields.io/badge/docs-transifex.com-blue)](https://developers.transifex.com/reference/api-javascript-sdk)
6+
7+
18
A javascript SDK for the [Transifex API (v3)](https://developers.transifex.com/reference)
29

310
## Intro

‎packages/cli/README.md‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,22 @@
1-
# Transifex Native CLI
1+
<p align="center">
2+
<a href="https://www.transifex.com">
3+
<img src="https://raw.githubusercontent.com/transifex/transifex-javascript/master/media/transifex.png" height="60">
4+
</a>
5+
</p>
6+
<p align="center">
7+
<i>Transifex Native is a full end-to-end, cloud-based localization stack for moderns apps.</i>
8+
</p>
9+
<p align="center">
10+
<img src="https://github.com/transifex/transifex-javascript/actions/workflows/npm-publish.yml/badge.svg">
11+
<a href="https://www.npmjs.com/package/@transifex/cli">
12+
<img src="https://img.shields.io/npm/v/@transifex/cli.svg">
13+
</a>
14+
<a href="https://developers.transifex.com/docs/native">
15+
<img src="https://img.shields.io/badge/docs-transifex.com-blue">
16+
</a>
17+
</p>
18+
19+
# Transifex Native SDK: JavaScript i18n CLI tool
220

321
A command line tool that parses `.js`, `.ts`, `.jsx`, `.tsx` and `.html` source files, extracts phrases marked for localization by [Transifex Native](https://www.transifex.com/native/) and pushes them to [Transifex](https:/www.transifex.com) for translation.
422

@@ -8,6 +26,8 @@ Related packages:
826

927
Learn more about Transifex Native in the [Transifex Developer Hub](https://developers.transifex.com/docs/native).
1028

29+
![cli](https://raw.githubusercontent.com/transifex/transifex-javascript/master/media/cli.gif)
30+
1131
# Upgrade to v2
1232

1333
If you are upgrading from the `1.x.x` version, please read this [migration guide](https://github.com/transifex/transifex-javascript/blob/HEAD/UPGRADE_TO_V2.md), as there are breaking changes in place.

‎packages/cli/package.json‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
{
22
"name": "@transifex/cli",
3-
"description": "Transifex Native CLI",
3+
"description": "i18n CLI tool for Transifex Native",
44
"version": "3.2.1",
55
"author": "Transifex",
66
"keywords": [
77
"transifex",
88
"i18n",
99
"l10n",
1010
"localization",
11+
"internationalization",
12+
"globalization",
13+
"translation",
1114
"cli"
1215
],
1316
"homepage": "https://github.com/transifex/transifex-javascript/tree/master/packages/cli",

‎packages/dom/README.md‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,22 @@
1-
# Transifex Native DOM
1+
<p align="center">
2+
<a href="https://www.transifex.com">
3+
<img src="https://raw.githubusercontent.com/transifex/transifex-javascript/master/media/transifex.png" height="60">
4+
</a>
5+
</p>
6+
<p align="center">
7+
<i>Transifex Native is a full end-to-end, cloud-based localization stack for moderns apps.</i>
8+
</p>
9+
<p align="center">
10+
<img src="https://github.com/transifex/transifex-javascript/actions/workflows/npm-publish.yml/badge.svg">
11+
<a href="https://www.npmjs.com/package/@transifex/dom">
12+
<img src="https://img.shields.io/npm/v/@transifex/dom.svg">
13+
</a>
14+
<a href="https://developers.transifex.com/docs/native">
15+
<img src="https://img.shields.io/badge/docs-transifex.com-blue">
16+
</a>
17+
</p>
18+
19+
# Transifex Native SDK: i18n DOM library
220

321
A utility library for managing the localization of generic HTML documents or fragments.
422
Taking as input a `document` object it:

0 commit comments

Comments
 (0)