diff --git a/landing/public/llms.txt b/landing/public/llms.txt new file mode 100644 index 000000000..f432920b3 --- /dev/null +++ b/landing/public/llms.txt @@ -0,0 +1,52 @@ +# Shepherd.js + +> Shepherd is an open-source JavaScript library for building guided product +> tours, user onboarding flows, trainings, and feature announcements on any +> website or web app. Steps render as accessible dialogs (keyboard navigation, +> focus trapping, aria attributes) that attach to DOM elements and are +> positioned by Floating UI. Works with React, Ember, Angular, Vue.js, +> ES Modules, or plain JavaScript. Free for open-source, personal, and +> non-commercial use (AGPL-3.0); commercial licenses are available. + +## When to use Shepherd + +Use Shepherd when a project needs to guide users through a web interface: + +- Onboarding new users with a step-by-step walkthrough of an app +- Announcing or explaining new features in context +- Guiding users through complex forms, wizards, or multi-step workflows +- Building in-app training or self-serve product education +- Highlighting one or more DOM elements with a modal overlay while explaining them + +How to use it: install with `npm install shepherd.js` (or load +`shepherd.js/dist/js/shepherd.mjs` and `shepherd.js/dist/css/shepherd.css` +from a script/link tag), create a `new Shepherd.Tour({ ... })`, add steps +with `tour.addStep({ title, text, attachTo, buttons })`, then call +`tour.start()`. It runs entirely in the browser; no backend service is +required. + +Shepherd is not a native mobile (iOS/Android) tour library and is not an +analytics product — it renders and orchestrates the tour UI itself. + +## Docs + +- [Documentation](https://docs.shepherdjs.dev/): installation, guides, API reference +- [Homepage in markdown](https://www.shepherdjs.dev/index.md): overview, install, quick example +- [Pricing and licensing](https://www.shepherdjs.dev/pricing): free plan, commercial licenses + +## Code + +- [GitHub repository](https://github.com/shipshapecode/shepherd): source, issues, releases +- [npm package](https://www.npmjs.com/package/shepherd.js): shepherd.js + +## Company + +- [About](https://www.shepherdjs.dev/about): who maintains Shepherd +- [Contact](https://www.shepherdjs.dev/contact): email, GitHub, Discord +- [Privacy](https://www.shepherdjs.dev/privacy): privacy policy +- [Ship Shape](https://shipshape.io/): the consultancy that maintains Shepherd + +## Optional + +- [Blog](https://www.shepherdjs.dev/blog): announcements and articles +- [Sitemap](https://www.shepherdjs.dev/sitemap-index.xml) diff --git a/landing/src/components/Footer.astro b/landing/src/components/Footer.astro index c719a59b9..3d1769839 100644 --- a/landing/src/components/Footer.astro +++ b/landing/src/components/Footer.astro @@ -35,7 +35,15 @@ import ShepherdWink from '../images/shepherd-head-wink.svg'; -
+ The page you requested does not exist. Here is where to look instead: +
+ ++ Shepherd is an open-source JavaScript library for guiding users through your + app. It lets you build product tours, user onboarding flows, trainings, and + feature announcements as a sequence of steps — dialogs that attach to + elements in your interface, highlight them with a modal overlay, and walk + users through what to do next. Steps are positioned by + Floating UI, so they never end up off + screen or cropped by an overflow. +
+ ++ Shepherd ships with full keyboard navigation support, focus trapping, and + a11y compliance via aria attributes, and its minimal default styles make it + easy to match your product's look and feel. It works with React, Ember, + Angular, Vue.js, ES Modules, or plain JavaScript, and is used in production + by companies such as Google, Ally, and CodePen. +
+ ++ Shepherd is maintained by Ship Shape, a + software consultancy specializing in web app development. Development + happens in the open on + GitHub, where you + can report issues, propose changes, and follow releases. The library is + published to npm as + shepherd.js. +
+ ++ Shepherd is free for open-source, personal, and non-commercial projects + under the AGPL-3.0 license. Commercial licenses fund the ongoing maintenance + of the library, documentation, and community — see + pricing for details, or read the + documentation to get started. +
++ Shepherd is maintained by Ship Shape. + Whether you have a question about using the library, want to report a bug, + are interested in a commercial license, or would like help building tours + for your product, here is the best way to reach us: +
+ ++ For documentation, guides, and the full API reference, visit + docs.shepherdjs.dev. For + licensing tiers and purchasing a commercial license, see + pricing. +
++ This policy describes how the shepherdjs.dev website, operated by + Ship Shape, handles data. It applies to + this website only — not to applications that embed the Shepherd library. +
+ ++ shepherdjs.dev is a static marketing and documentation site. We do not + require accounts, and we do not collect personal information to browse the + site. We use PostHog for product analytics, + which records anonymous usage data such as pages viewed, referring site, and browser + and device type. This helps us understand which parts of the site and documentation + are useful. PostHog may use cookies or local storage to distinguish visitors; + data is processed on PostHog's US cloud. +
+ ++ Commercial license purchases are processed by + Polar, our checkout provider. Your payment + details are entered on and processed by Polar — they are never sent to or + stored on shepherdjs.dev. Polar shares with us only the information needed + to fulfill your license, such as your name, email address, and order + details. +
+ ++ The Shepherd JavaScript library itself, installed in your own applications, + does not collect, transmit, or store any data about your users. It runs + entirely in the browser of the application that embeds it. +
+ ++ You can block analytics with standard browser tooling (content blockers, Do + Not Track) without affecting your ability to use this site. If you have + questions about this policy, or want data we may hold about you (such as + order records) accessed or deleted, email + ahoy@shipshape.io. We will update + this page if our practices change. +
+