Skip to content

Commit a727f73

Browse files
author
nbasili
committed
Update README.md
1 parent bcaba31 commit a727f73

File tree

4 files changed

+11
-20
lines changed

4 files changed

+11
-20
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
# Transifex Javascript Toolkit
55

6-
Transifex Javascript Toolkit is a collection of tools that allow you to easily localize your Javascript applications using [Transifex Native](https://www.transifex.com/native/).
6+
Transifex Javascript Toolkit is a collection of tools to easily localize your Javascript applications using [Transifex Native](https://www.transifex.com/native/).
77
The toolkit features fetching translations over the air (OTA) to your apps.
88

99
This project adheres to the Contributor Covenant [code of conduct](/CODE_OF_CONDUCT.md). To contribute to Transifex Javascript Toolkit, please check out the [contribution guidelines](/CONTRIBUTING.md).

packages/react/README.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,16 @@ class Example extends Component {
4545
```
4646

4747
Available optional props:
48-
| Prop | Type | Description |
49-
| ---------- | ------ | ------------------------------------------- |
50-
| _context | String | String context, affects key generation |
51-
| _comment | String | Developer comment |
52-
| _charlimit | Number | Character limit instruction for translators |
53-
| _tags | String | Comma separated list of tags |
54-
| _key | String | Custom string key |
55-
56-
48+
| Prop | Type | Description |
49+
| ---------- | ------- | ---------------------------------------------- |
50+
| _str | String | Source string |
51+
| _html | Boolean | Render source string as HTML inside a `div` tag|
52+
| _inline | Boolean | Wrap translation in `span` when `_html` is used|
53+
| _context | String | String context, affects key generation |
54+
| _key | String | Custom string key |
55+
| _comment | String | Developer comment |
56+
| _charlimit | Number | Character limit instruction for translators |
57+
| _tags | String | Comma separated list of tags |
5758

5859
# License
5960

packages/react/package-lock.json

-9
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/react/package.json

-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@
4242
"@testing-library/jest-dom": "^5.11.2",
4343
"@testing-library/react": "^10.4.7",
4444
"@transifex/native": "^0.1.0",
45-
"cross-env": "^7.0.2",
4645
"eslint": "^6.6.0",
4746
"eslint-config-airbnb": "^18.2.0",
4847
"eslint-plugin-import": "^2.22.0",

0 commit comments

Comments
 (0)