@transifex/native 3.1.0 → 3.2.2

package/README.md

@@ -1,4 +1,22 @@
-# Transifex Native for Javascript
+<p align="center">
+  <a href="https://www.transifex.com">
+    <img src="https://raw.githubusercontent.com/transifex/transifex-javascript/master/media/transifex.png" height="60">
+  </a>
+</p>
+<p align="center">
+  <i>Transifex Native is a full end-to-end, cloud-based localization stack for moderns apps.</i>
+</p>
+<p align="center">
+  <img src="https://github.com/transifex/transifex-javascript/actions/workflows/npm-publish.yml/badge.svg">
+  <a href="https://www.npmjs.com/package/@transifex/native">
+    <img src="https://img.shields.io/npm/v/@transifex/native.svg">
+  </a>
+  <a href="https://developers.transifex.com/docs/native">
+    <img src="https://img.shields.io/badge/docs-transifex.com-blue">
+  </a>
+</p>
+
+# Transifex Native SDK: JavaScript i18n
 
 A general purpose Javascript library for localizing web apps using [Transifex Native](https://www.transifex.com/native/).
 
@@ -10,6 +28,24 @@ Related packages:
 * [@transifex/react](https://www.npmjs.com/package/@transifex/react)
 * [@transifex/cli](https://www.npmjs.com/package/@transifex/cli)
 
+Learn more about Transifex Native in the [Transifex Developer Hub](https://developers.transifex.com/docs/native).
+
+# How it works
+
+**Step1**: Create a Transifex Native project in [Transifex](https://www.transifex.com).
+
+**Step2**: Grab credentials.
+
+**Step3**: Internationalize the code using the SDK.
+
+**Step4**: Push source phrases using the `@transifex/cli` tool.
+
+**Step5**: Translate the app using over-the-air updates.
+
+No translation files required.
+
+![native](https://raw.githubusercontent.com/transifex/transifex-javascript/master/media/native.gif)
+
 # Upgrade to v2
 
 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.
@@ -243,6 +279,87 @@ const html = t('<b>Hello {username}</b>', {
 });
 ```
 
+## Push source content
+
+For server side integrations you can also push source content programmatically
+without using the CLI.
+
+```js
+tx.pushSource(payload, params): Promise
+payload: Object({
+  key: {
+   string: String,
+    meta: {
+      context: String,
+      developer_comment: String,
+      character_limit: Number,
+      tags: Array(String),
+      occurrences: Array(String),
+    },
+  },
+  key: { .. }
+})
+params: Object({
+  // Replace the entire resource content with the pushed content of this request
+  purge: Boolean,
+
+  // Replace the existing string tags with the tags of this request
+  overrideTags: Boolean,
+
+  // If true, when wait for processing to be complete before
+  // resolving this promise
+  noWait: Boolean,
+})
+```
+
+For example:
+
+```js
+const { createNativeInstance } = require('@transifex/native');
+
+const tx = createNativeInstance({
+  token: 'token',
+  secret: 'secret',
+});
+
+await tx.pushSource({
+  'mykey': {
+    string: 'My string',
+    meta: {
+      context: 'content', // optional
+      developer_comment: 'developer comment', // optional
+      character_limit: 10, // optional
+      tags: ['tag1', 'tag2'], // optional
+      occurrences: ['file.jsx', 'file2.js'], // optional
+    },
+  }
+});
+```
+
+## Invalidate CDS cache
+
+Server side integrations can also invalidate the CDS cache programmatically.
+
+```js
+tx.invalidateCDS({
+  // if true, then purge the cache entirely (not recommended)
+  purge: Boolean,
+}): Promise
+```
+
+For example:
+
+```js
+const { createNativeInstance } = require('@transifex/native');
+
+const tx = createNativeInstance({
+  token: 'token',
+  secret: 'secret',
+});
+
+await tx.invalidateCDS();
+```
+
 ## Events
 
 Library for listening to various async events.