Skip to content

Commit 895d92a

Browse files
Update documentation to clarify license usage and add HTML comment attribution for React on Rails
1 parent 125b364 commit 895d92a

File tree

4 files changed

+17
-8
lines changed

4 files changed

+17
-8
lines changed

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ After a release, please make sure to run `bundle exec rake update_changelog`. Th
2323

2424
Changes since the last non-beta release.
2525

26+
#### Added
27+
28+
- **Attribution Comment**: Added HTML comment attribution to Rails views containing React on Rails functionality. The comment automatically displays which version is in use (open source React on Rails or React on Rails Pro) and, for Pro users, shows the license status. This helps identify React on Rails usage across your application. [PR #1857](https://github.com/shakacode/react_on_rails/pull/1857) by [AbanoubGhadban](https://github.com/AbanoubGhadban).
29+
2630
#### Breaking Changes
2731

2832
- **React on Rails Core Package**: Several Pro-only methods have been removed from the core package and are now exclusively available in the `react-on-rails-pro` package. If you're using any of the following methods, you'll need to migrate to React on Rails Pro:
@@ -65,7 +69,7 @@ To migrate to React on Rails Pro:
6569
import ReactOnRails from 'react-on-rails-pro';
6670
```
6771

68-
4. If you're using a free license for personal (non-production) use, you can obtain one at [React on Rails Pro License](https://www.shakacode.com/react-on-rails-pro). The Pro package is free for personal, educational, and non-production usage.
72+
4. If you're using a free license, you can obtain one at [React on Rails Pro License](https://www.shakacode.com/react-on-rails-pro). **Important: The free 3-month evaluation license is intended for personal, educational, and evaluation purposes only. It should NOT be used for production deployments.** Production use requires a paid license.
6973

7074
**Note:** If you're not using any of the Pro-only methods listed above, no changes are required.
7175

react_on_rails_pro/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ You can find the **package** version numbers from this repo's tags and below in
1818

1919
### Added
2020
- Added `cached_stream_react_component` helper method, similar to `cached_react_component` but for streamed components.
21+
- **License Validation System**: Implemented comprehensive JWT-based license validation with offline verification using RSA-256 signatures. License validation occurs at startup in both Ruby and Node.js environments. Supports required fields (`sub`, `iat`, `exp`) and optional fields (`plan`, `organization`, `iss`). FREE evaluation licenses are available for 3 months at [shakacode.com/react-on-rails-pro](https://shakacode.com/react-on-rails-pro). [PR #1857](https://github.com/shakacode/react_on_rails/pull/1857) by [AbanoubGhadban](https://github.com/AbanoubGhadban).
2122

2223
### Changed (Breaking)
2324
- `config.prerender_caching`, which controls caching for non-streaming components, now also controls caching for streamed components. To disable caching for an individual render, pass `internal_option(:skip_prerender_cache)`.

react_on_rails_pro/CI_SETUP.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ This guide explains how to configure React on Rails Pro licenses for CI/CD envir
1010
2. Add `REACT_ON_RAILS_PRO_LICENSE` to your CI environment variables
1111
3. Done! Your tests will run with a valid license
1212

13+
**⚠️ Important: The free 3-month evaluation license is intended for personal, educational, and evaluation purposes only (including CI/CD testing). It should NOT be used for production deployments. Production use requires a paid license.**
14+
1315
## Getting a License for CI
1416

1517
You have two options:
@@ -21,8 +23,8 @@ You have two options:
2123

2224
### Option 2: Create a Dedicated CI License
2325
- Register with `ci@yourcompany.com` or similar
24-
- Get a FREE 3-month license
25-
- Renew every 3 months (or use a paid license)
26+
- Get a FREE 3-month evaluation license (for personal, educational, and evaluation purposes only)
27+
- Renew every 3 months (or use a paid license for production)
2628

2729
## Configuration by CI Provider
2830

@@ -447,15 +449,15 @@ jobs:
447449

448450
### When to Use Different Licenses
449451

450-
- **CI/Test**: FREE license (renew every 3 months)
451-
- **Staging**: Can use FREE or paid license
452-
- **Production**: Paid license (required)
452+
- **CI/Test**: FREE evaluation license (for personal, educational, and evaluation purposes - renew every 3 months)
453+
- **Staging**: Can use FREE evaluation license for non-production testing or paid license
454+
- **Production**: Paid license (required - free licenses are NOT for production use)
453455

454456
## License Renewal
455457

456458
### Setting Up Renewal Reminders
457459

458-
FREE licenses expire every 3 months. Set a reminder:
460+
FREE evaluation licenses (for personal, educational, and evaluation purposes only) expire every 3 months. Set a reminder:
459461

460462
1. **Calendar reminder**: 2 weeks before expiration
461463
2. **CI notification**: Tests will fail when expired

react_on_rails_pro/LICENSE_SETUP.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,13 @@ This document explains how to configure your React on Rails Pro license.
1515

1616
**No credit card required!**
1717

18+
**⚠️ Important: The free 3-month evaluation license is intended for personal, educational, and evaluation purposes only. It should NOT be used for production deployments. Production use requires a paid license.**
19+
1820
## License Types
1921

2022
### Free License
2123
- **Duration**: 3 months
22-
- **Usage**: Development, testing, evaluation, CI/CD
24+
- **Usage**: Personal, educational, and evaluation purposes only (development, testing, evaluation, CI/CD) - **NOT for production**
2325
- **Cost**: FREE - just register with your email
2426
- **Renewal**: Get a new free license or upgrade to paid
2527

0 commit comments

Comments
 (0)