-
-
Notifications
You must be signed in to change notification settings - Fork 655
More license updates #3341
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
More license updates #3341
Changes from all commits
198d1be
d0a31df
cacc29a
81fce03
f3dd9f5
eaa0053
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| --- | ||
| title: License & Pricing | ||
| description: Understanding Shepherd.js licensing and when you need a commercial license | ||
| --- | ||
|
|
||
| Shepherd.js uses a **dual-licensing model** to support both open source and commercial use. | ||
|
|
||
| ## Free Use - AGPL-3.0 | ||
|
|
||
| Shepherd.js is **free for open source and non-commercial use** under the AGPL-3.0 license. | ||
|
|
||
| ### Who Can Use Shepherd.js for Free? | ||
|
|
||
| ✅ **Open Source Projects** | ||
| - Your project is open source under an AGPL-compatible license | ||
| - Your complete source code is publicly available | ||
|
Comment on lines
+6
to
+16
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Tighten compound adjectives for clearer phrasing. ✏️ Suggested copy edits-Shepherd.js uses a **dual-licensing model** to support both open source and commercial use.
+Shepherd.js uses a **dual licensing model** to support both open-source and commercial use.
-✅ **Open Source Projects**
-- Your project is open source under an AGPL-compatible license
+✅ **Open-Source Projects**
+- Your project is open source under an AGPL-compatible license🧰 Tools🪛 LanguageTool[uncategorized] ~6-~6: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL) [uncategorized] ~14-~14: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL) 🤖 Prompt for AI Agents |
||
|
|
||
| ✅ **Personal & Non-Commercial Use** | ||
| - Personal projects, portfolios, and hobby websites | ||
| - Educational purposes (students, teachers, coursework) | ||
| - Academic research projects | ||
|
|
||
| ✅ **Evaluation & Testing** | ||
| - Evaluating Shepherd.js for up to 30 days | ||
| - Development, testing, and staging environments during evaluation | ||
| - Proof-of-concept and demo projects | ||
|
|
||
| ### AGPL-3.0 Requirements | ||
|
|
||
| When using Shepherd.js under AGPL-3.0, you must: | ||
| - Make your complete source code available if you distribute or provide your software over a network | ||
| - License your code under AGPL-3.0 or a compatible license | ||
| - Comply with all AGPL-3.0 terms | ||
|
|
||
| [Read the full AGPL-3.0 license text](https://github.com/shipshapecode/shepherd/blob/main/LICENSE.md) | ||
|
|
||
| --- | ||
|
|
||
| ## Commercial License | ||
|
|
||
| You **must purchase a commercial license** if: | ||
|
|
||
| ❌ **Commercial Products & Services** | ||
| - You're building a commercial product, application, SaaS, or website that generates revenue | ||
| - Your company generates revenue (even if the specific project using Shepherd.js does not) | ||
| - You're using Shepherd.js in any customer-facing commercial application | ||
|
|
||
| ❌ **Closed-Source Use** | ||
| - You cannot or don't want to open-source your code under AGPL-3.0 | ||
| - You want to keep your source code proprietary | ||
| - You want to avoid AGPL's source code disclosure requirements | ||
|
|
||
| ❌ **White-Label, Resale, or OEM Use** | ||
| - You're embedding Shepherd.js in a product you sell or distribute | ||
| - You're offering Shepherd.js as part of a commercial service or hosting | ||
| - You're using Shepherd.js in a product sold to other businesses | ||
|
|
||
| ❌ **Internal Business Tools** | ||
| - You're using Shepherd.js for internal tools, dashboards, or admin panels in a revenue-generating company | ||
| - Even if the tool is not customer-facing, commercial licenses are required for for-profit companies | ||
|
|
||
|
Comment on lines
+10
to
+61
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Clarify AGPL vs commercial requirements to avoid legal/usage confusion. AGPL-3.0 allows commercial use as long as its obligations are met. The current wording implies all commercial use requires a paid license, which conflicts with standard AGPL terms and can mislead users. Recommend reframing: a commercial license is required only if the user can’t or won’t comply with AGPL obligations (e.g., source disclosure/network use). ✏️ Suggested wording adjustment-Shepherd.js is **free for open source and non-commercial use** under the AGPL-3.0 license.
+Shepherd.js is **free to use under AGPL-3.0** as long as you comply with its obligations
+including source disclosure for network use.
-You **must purchase a commercial license** if:
+You **must purchase a commercial license** if you cannot or do not want to comply
+with AGPL-3.0 obligations, such as source disclosure.
-❌ **Commercial Products & Services**
-- You're building a commercial product, application, SaaS, or website that generates revenue
-- Your company generates revenue (even if the specific project using Shepherd.js does not)
-- You're using Shepherd.js in any customer-facing commercial application
+❌ **Commercial Use Without AGPL Compliance**
+- You want to keep your source code proprietary
+- You do not want to disclose source code for network use
+- You cannot license your modifications under AGPL-3.0 or a compatible license🧰 Tools🪛 LanguageTool[uncategorized] ~14-~14: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL) [style] ~51-~51: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_WANT_TO_VB) 🤖 Prompt for AI Agents |
||
| ### Benefits of Commercial License | ||
|
|
||
| - ✅ **No AGPL obligations** - Keep your code proprietary | ||
| - ✅ **Legal protection and indemnification** | ||
| - ✅ **Priority support and updates** | ||
| - ✅ **Lifetime license with no recurring fees** | ||
|
|
||
| [**View Pricing & Purchase →**](https://shepherdjs.dev/pricing) | ||
|
|
||
| --- | ||
|
|
||
| ## Still Not Sure? | ||
|
|
||
| If you're unsure whether you need a commercial license: | ||
|
|
||
| **When in doubt:** If your organization generates revenue, you likely need a commercial license. | ||
|
|
||
| **Contact us:** [[email protected]](mailto:[email protected]) | ||
|
|
||
| --- | ||
|
|
||
| ## Framework Wrappers | ||
|
|
||
| ### React Shepherd | ||
|
|
||
| The `react-shepherd` wrapper is licensed under MIT, but it depends on `shepherd.js` which is AGPL-3.0. | ||
|
|
||
| If you need a commercial license for Shepherd.js, you also need one when using the React wrapper. | ||
|
|
||
| ### Other Wrappers | ||
|
|
||
| - [Angular Shepherd](https://github.com/shipshapecode/angular-shepherd) | ||
| - [Vue Shepherd](https://github.com/shipshapecode/vue-shepherd) | ||
| - [Ember Shepherd](https://github.com/RobbieTheWagner/ember-shepherd) | ||
|
|
||
| All wrappers depend on the core Shepherd.js library and inherit its licensing requirements. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,3 +12,7 @@ | |
| /npm-debug.log* | ||
| /stats.html | ||
| /yarn-error.log | ||
|
|
||
| # Auto-generated from root during build | ||
| README.md | ||
| LICENSE.md | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,4 +16,3 @@ yarn.lock | |
| yarn-error.log | ||
|
|
||
| CONTRIBUTING.md | ||
| HISTORY.md | ||
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor grammar: hyphenate "open-source" when used as an adjective.
When "open source" is used as a compound adjective before a noun, it should be hyphenated.
📝 Suggested fix
📝 Committable suggestion
🧰 Tools
🪛 LanguageTool
[grammar] ~18-~18: Use a hyphen to join words.
Context: ...erd](https://shepherdjs.dev/) is an open source, fully featured, digital adoption...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents