Skip to content

Commit 2abe44f

Browse files
RobbieTheWagnerRobbieTheWagner
committed
Sync READMEs
1 parent 1414bba commit 2abe44f

File tree

2 files changed

+44
-33
lines changed

2 files changed

+44
-33
lines changed

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,14 @@ Our release process is mostly automated. For more details, see [RELEASE.md](RELE
7676

7777
## Projects Already Using Shepherd
7878

79+
### Rails gems
80+
81+
### [abraham](https://github.com/actmd/abraham)
82+
83+
Rails engine that generates and tracks Shepherd tours within an application
84+
85+
### Websites and Apps
86+
7987
### [SimplePlanner](https://simpleplanner.io)
8088

8189
[SimplePlanner](https://simpleplanner.io) uses Shepherd to help new users get familiar with its collaborative scheduling approach.

‎shepherd.js/README.md‎

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -8,69 +8,73 @@
88
[![npm version](https://badge.fury.io/js/shepherd.js.svg)](http://badge.fury.io/js/shepherd.js)
99
![Download count all time](https://img.shields.io/npm/dt/shepherd.js.svg)
1010
![npm](https://img.shields.io/npm/dm/shepherd.js.svg)
11-
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fshipshapecode%2Fshepherd.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%shepherd-pro%2Fshepherd?ref=badge_shield)
11+
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fshipshapecode%2Fshepherd.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%shipshapecode%2Fshepherd?ref=badge_shield)
1212
![npm bundle size](https://img.shields.io/bundlephobia/minzip/shepherd.js.svg)
13-
[![Test](https://github.com/shepherd-pro/shepherd/actions/workflows/test.yml/badge.svg)](https://github.com/shepherd-pro/shepherd/actions/workflows/test.yml)
13+
[![Test](https://github.com/shipshapecode/shepherd/actions/workflows/test.yml/badge.svg)](https://github.com/shipshapecode/shepherd/actions/workflows/test.yml)
1414
[![Maintainability](https://api.codeclimate.com/v1/badges/b295b0cc0d828ccc1b76/maintainability)](https://codeclimate.com/github/shipshapecode/shepherd/maintainability)
1515
[![Test Coverage](https://api.codeclimate.com/v1/badges/b295b0cc0d828ccc1b76/test_coverage)](https://codeclimate.com/github/shipshapecode/shepherd/test_coverage)
1616
[![StackShare](https://img.shields.io/badge/Follow%20on-StackShare-blue.svg?logo=stackshare&style=flat)](https://stackshare.io/shepherd-js)
1717

18+
[Shepherd](https://shepherdjs.dev/) is an open source, fully featured, digital adoption platform (DAP) and user on-boarding service. Use our
19+
hosted SaaS or deploy to your own infrastructure to run on-premise.
1820

19-
<a href="https://shepherdjs.dev/">
20-
<img
21-
src="https://shepherdjs.dev/img/demo.png"
22-
alt="Guide your users through a tour of your app"
23-
style="height: auto; max-width: 800px; width: 100%;"/>
24-
</a>
25-
26-
Browsers support
21+
Supported Browsers
2722
----------------------------------------------------------
2823

2924
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
3025
| --------- | --------- | --------- | --------- |
3126
| Edge| last 2 versions| last 2 versions| last 2 versions
3227

28+
# Shepherd
3329

34-
## Documentation
35-
36-
[API documentation](https://docs.shepherdjs.dev/)
30+
Shepherd makes it simple to create custom user on-boarding tours, trainings and announcements to drive user adoption.
3731

38-
## Demo
32+
Shepherd enables you to guide users through a custom tour or journey within your app or website. Highly customizable with minimal styles, Shepherd allows for powerful customization while being easy to use. Various frameworks supported including React, Ember, Angular, Vue.js, ES Modules, or plain JavaScript.
3933

40-
[Demo](https://shepherdjs.dev/demo)
34+
# Demo
35+
See Shepherd Live on our website by clicking on the image:
36+
<a href="https://shepherdjs.dev">
37+
<img
38+
src="https://shepherdjs.dev/img/demo.png"
39+
alt="Guide your users through a tour of your app"
40+
style="height: auto; max-width: 800px; width: 100%;"/>
41+
</a>
4142

42-
## Contributing
43+
# Using Shepherd
4344

44-
We encourage contributions of all kinds. If you would like to contribute in some way, please review our [guidelines for contributing](CONTRIBUTING.md).
45+
### Shepherd Open Source Library
4546

46-
## Releasing
47+
The Shepherd Standalone Library has been open source since the very beginning. Check out our tutorials here:
4748

48-
Our release process is mostly automated. For more details, see [RELEASE.md](RELEASE.md).
49+
#### [React Shepherd Wrapper](packages/react)
50+
#### [Angular Shepherd Wrapper](https://github.com/shipshapecode/angular-shepherd)
51+
#### [Vue Shepherd Wrapper](https://github.com/shipshapecode/vue-shepherd)
52+
#### [Ember Shepherd Wrapper](https://github.com/RobbieTheWagner/ember-shepherd)
4953

50-
## License
51-
[MIT License](LICENSE.md)
54+
### Commercial license
5255

53-
## Projects Using Shepherd
56+
If you want to use Shepherd for a commercial application, theme or plugin the commercial license is the appropriate license. With this option, your source code is kept proprietary. Purchase a commercial license at [shepherdjs.dev](http://shepherdjs.dev/pricing)
5457

55-
Here we showcase some of the awesome libraries built using Shepherd.
58+
# White Glove Services
5659

57-
### JS Framework Wrappers
60+
If you have an idea or project in mind and would like to engage our team to build a custom tour, training or on-boarding experience, [get in touch](mailto:[email protected])!
5861

59-
### [ember-shepherd](https://github.com/shepherd-pro/ember-shepherd)
6062

61-
Ember addon for the site tour library Shepherd
63+
## Resources
6264

63-
### [angular-shepherd](https://github.com/shepherd-pro/angular-shepherd)
65+
- [Website](https://shepherdjs.dev/)
66+
- [Documentation](https://docs.shepherdjs.dev/)
67+
- [Demo](https://shepherdjs.dev/)
68+
- [Discord](https://discord.gg/EGcDW5NSud)
6469

65-
An Angular wrapper for the site tour library Shepherd
6670

67-
### [react-shepherd](https://github.com/shepherd-pro/react-shepherd)
71+
## Contributing
6872

69-
A React wrapper for the site tour library Shepherd
73+
We encourage contributions of all kinds. If you would like to contribute in some way, please review our [guidelines for contributing](CONTRIBUTING.md).
74+
Our release process is mostly automated. For more details, see [RELEASE.md](RELEASE.md).
7075

71-
### [vue-shepherd](https://github.com/shepherd-pro/vue-shepherd)
7276

73-
A Vue wrapper for the site tour library Shepherd
77+
## Projects Already Using Shepherd
7478

7579
### Rails gems
7680

@@ -94,7 +98,6 @@ Check out the [Envato Tuts+ Startup Series on its codebase](https://code.tutsplu
9498

9599
[Snapsure](https://snapsure.app) uses Shepherd to help photographers learn how to set up alerts for their desired picture-perfect weather conditions.
96100

97-
98101
### [Drupal](https://www.drupal.org/docs/8/core/modules/tour/overview)
99102

100103
The [Drupal](https://www.drupal.org/docs/8/core/modules/tour/overview) CMS uses Shepherd to offer tours of it's core modules, and allows developers to add Tours to their custom and contributed modules.

0 commit comments

Comments
 (0)