Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: v2.0.0 migration guide #90

Merged
merged 1 commit into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

# Crowdin OTA JavaScript client [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fcrowdin%2Fota-client-js&text=Lightweight%20library%20for%20Crowdin%20Over-The-Air%20Content%20Delivery.%20The%20best%20way%20to%20deliver%20translations%20to%20your%20site%20Over-The-Air) [![GitHub Repo stars](https://img.shields.io/github/stars/crowdin/ota-client-js?style=social&cacheSeconds=1800)](https://github.com/crowdin/ota-client-js/stargazers)

Lightweight library for Crowdin Over-The-Air Content Delivery. The best way to deliver translations to your site Over-The-Air :dizzy:
Lightweight library (zero-dependencies) for Crowdin Over-The-Air Content Delivery. The best way to deliver translations to your site Over-The-Air :dizzy:

<div align="center">

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@crowdin/ota-client",
"version": "1.1.3",
"version": "2.0.0",
"description": "JavaScript library for Crowdin OTA Content Delivery",
"main": "out/index.js",
"types": "out/index.d.ts",
Expand Down
23 changes: 23 additions & 0 deletions website/docs/releases/migration-2.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Migration from 1.x to 2.x

Migrating to 2.x is a major update, but should be straightforward and easy. The changes that may affect your integration are described below.

### Node.js Version

The minimum required version of Node.js is **18.x**.

### Axios Dependency Removed

In this release, we've removed the Axios dependency from the Crowdin OTA JS client. This change addresses security concerns and streamlines the client by using the native Fetch API instead.

Axios was only used for a few GET operations that can be handled by the native Node.js `fetch`. In addition, developers were experiencing issues with Axios in modern build environments, making it cumbersome to use.

#### Benefits

- **Smaller Bundle**: Reduces the size of the client for better performance.
- **Improved Security**: Fewer dependencies means less potential vulnerabilities. Now OTA JS client is **zero-dependency** library.
- **Simplified Setup**: No more manual Axios installation or configuration needed.

#### Migration Steps

If you have a custom Axios instance used for the OTA JS client, you can now remove it and uninstall the Axios package if it's not being used elsewhere. Otherwise, no changes are required.
5 changes: 4 additions & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,10 @@ const sidebars = {
{
type: 'category',
label: 'Releases',
items: ['releases/migration-1'],
items: [
'releases/migration-1',
'releases/migration-2',
],
},
],
};
Expand Down
Loading