Skip to content

Commit

Permalink
Update peerDeps and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Nikos Vasileiou committed Nov 25, 2021
1 parent c93cd0d commit f46ec94
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 7 deletions.
5 changes: 5 additions & 0 deletions UPGRADE_TO_V2.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ containing the following **breaking changes**:
Although some libraries might be 10.x.x compatible, we now run tests
against node >= 12.x.x

# Angular 12 is the minimum supported version

@transifex/angular has been tested to work with Angular 12 & 13. If you are working
on an Angular 11 project please use the 1.x.x version.

# Default key generation

Version 1.x.x is using hashed based keys by default, unless
Expand Down
8 changes: 8 additions & 0 deletions packages/angular/projects/tx-native-angular-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ Related packages:

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.



## Table of Contents
* [Requirements](#requirements)
* [Installation](#installation)
* [Usage](#usage)
* [Initialization](#initialization)
Expand All @@ -24,6 +27,11 @@ If you are upgrading from the `1.x.x` version, please read this [migration guide
* [License](#license)


# Requirements

Angular 12 or 13 is required. If you are using older versions, please use the `1.x.x` version of
Transifex Native related packages.

# Installation

Install the library and its dependencies using:
Expand Down
6 changes: 3 additions & 3 deletions packages/angular/projects/tx-native-angular-sdk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
"repository": "git://github.com/transifex/transifex-javascript.git",
"license": "Apache-2.0",
"peerDependencies": {
"@angular/common": "^11.0.0 || ^12.0.0 || ^13.0.0",
"@angular/core": "^11.0.0 || ^12.0.0 || ^13.0.0",
"@transifex/native": "^1.0.0 || ^2.0.0"
"@angular/common": "^12.0.0 || ^13.0.0",
"@angular/core": "^12.0.0 || ^13.0.0",
"@transifex/native": "^2.0.0"
}
}
3 changes: 0 additions & 3 deletions packages/api/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@
"lint": "eslint src",
"publish-npm": "npm publish"
},
"peerDependencies": {
"@transifex/jsonapi": "^1.0.0 || ^2.0.0"
},
"dependencies": {
"core-js": "^3.17.2"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"node": ">=12.0.0"
},
"peerDependencies": {
"@transifex/native": "^1.0.0 || ^2.0.0",
"@transifex/native": "^2.0.0",
"prop-types": "^15.0.0",
"react": "^16.0.0 || ^17.0.0"
},
Expand Down

0 comments on commit f46ec94

Please sign in to comment.