Skip to content

Commit d0a31df

Browse files
Add license page to docs site
1 parent 198d1be commit d0a31df

3 files changed

Lines changed: 105 additions & 0 deletions

File tree

docs-src/astro.config.mjs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ export default defineConfig({
4747
{
4848
label: 'Usage',
4949
link: '/guides/usage/'
50+
},
51+
{
52+
label: 'License & Pricing',
53+
link: '/guides/license/'
5054
}
5155
]
5256
},

docs-src/src/content/docs/guides/install.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ title: Installation
44

55
import { Tabs, TabItem } from '@astrojs/starlight/components';
66

7+
:::note[License Information]
8+
Shepherd.js is **free for open source and non-commercial use** under AGPL-3.0. Commercial projects require a commercial license. [Learn more about licensing →](/guides/license/)
9+
:::
10+
711
## Install Directly
812

913
<Tabs>
Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: License & Pricing
3+
description: Understanding Shepherd.js licensing and when you need a commercial license
4+
---
5+
6+
Shepherd.js uses a **dual-licensing model** to support both open source and commercial use.
7+
8+
## Free Use - AGPL-3.0
9+
10+
Shepherd.js is **free for open source and non-commercial use** under the AGPL-3.0 license.
11+
12+
### Who Can Use Shepherd.js for Free?
13+
14+
**Open Source Projects**
15+
- Your project is open source under an AGPL-compatible license
16+
- Your complete source code is publicly available
17+
18+
**Personal & Non-Commercial Use**
19+
- Personal projects, portfolios, and hobby websites
20+
- Educational purposes (students, teachers, coursework)
21+
- Academic research projects
22+
23+
**Evaluation & Testing**
24+
- Evaluating Shepherd.js for up to 30 days
25+
- Development, testing, and staging environments during evaluation
26+
- Proof-of-concept and demo projects
27+
28+
### AGPL-3.0 Requirements
29+
30+
When using Shepherd.js under AGPL-3.0, you must:
31+
- Make your complete source code available if you distribute or provide your software over a network
32+
- License your code under AGPL-3.0 or a compatible license
33+
- Comply with all AGPL-3.0 terms
34+
35+
[Read the full AGPL-3.0 license text](https://github.com/shipshapecode/shepherd/blob/main/LICENSE.md)
36+
37+
---
38+
39+
## Commercial License
40+
41+
You **must purchase a commercial license** if:
42+
43+
**Commercial Products & Services**
44+
- You're building a commercial product, application, SaaS, or website that generates revenue
45+
- Your company generates revenue (even if the specific project using Shepherd.js does not)
46+
- You're using Shepherd.js in any customer-facing commercial application
47+
48+
**Closed-Source Use**
49+
- You cannot or don't want to open-source your code under AGPL-3.0
50+
- You want to keep your source code proprietary
51+
- You want to avoid AGPL's source code disclosure requirements
52+
53+
**White-Label, Resale, or OEM Use**
54+
- You're embedding Shepherd.js in a product you sell or distribute
55+
- You're offering Shepherd.js as part of a commercial service or hosting
56+
- You're using Shepherd.js in a product sold to other businesses
57+
58+
**Internal Business Tools**
59+
- You're using Shepherd.js for internal tools, dashboards, or admin panels in a revenue-generating company
60+
- Even if the tool is not customer-facing, commercial licenses are required for for-profit companies
61+
62+
### Benefits of Commercial License
63+
64+
-**No AGPL obligations** - Keep your code proprietary
65+
-**Legal protection and indemnification**
66+
-**Priority support and updates**
67+
-**Lifetime license with no recurring fees**
68+
69+
[**View Pricing & Purchase →**](https://shepherdjs.dev/pricing)
70+
71+
---
72+
73+
## Still Not Sure?
74+
75+
If you're unsure whether you need a commercial license:
76+
77+
**When in doubt:** If your organization generates revenue, you likely need a commercial license.
78+
79+
**Contact us:** [ahoy@shipshape.io](mailto:ahoy@shipshape.io)
80+
81+
---
82+
83+
## Framework Wrappers
84+
85+
### React Shepherd
86+
87+
The `react-shepherd` wrapper is licensed under MIT, but it depends on `shepherd.js` which is AGPL-3.0.
88+
89+
If you need a commercial license for Shepherd.js, you also need one when using the React wrapper.
90+
91+
### Other Wrappers
92+
93+
- [Angular Shepherd](https://github.com/shipshapecode/angular-shepherd)
94+
- [Vue Shepherd](https://github.com/shipshapecode/vue-shepherd)
95+
- [Ember Shepherd](https://github.com/RobbieTheWagner/ember-shepherd)
96+
97+
All wrappers depend on the core Shepherd.js library and inherit its licensing requirements.

0 commit comments

Comments
 (0)