From b99fbf9d38ba75e584c22bb05b859c9f25c1cd1c Mon Sep 17 00:00:00 2001 From: Robbie Wagner Date: Tue, 19 Nov 2024 12:26:27 -0500 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3e7639fa..f46027f1 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,21 @@ # ember-shepherd -[Short description of the addon.] +Ship Shape + +**[ember-shepherd is built and maintained by Ship Shape. Contact us for Ember.js consulting, development, and training for your project](https://shipshape.io/ember-consulting/)**. + +[![npm version](https://badge.fury.io/js/ember-shepherd.svg)](http://badge.fury.io/js/ember-shepherd) +![Download count all time](https://img.shields.io/npm/dt/ember-shepherd.svg) +[![npm](https://img.shields.io/npm/dm/ember-shepherd.svg)]() +[![Ember Observer Score](http://emberobserver.com/badges/ember-shepherd.svg)](http://emberobserver.com/addons/ember-shepherd) +[![CI](https://github.com/RobbieTheWagner/ember-shepherd/actions/workflows/ci.yml/badge.svg)](https://github.com/RobbieTheWagner/ember-shepherd/actions/workflows/ci.yml) + +This is an Ember wrapper for the [Shepherd](https://github.com/shipshapecode/shepherd), site tour, library. It provides additional functionality, on top of Shepherd, as well. ## Compatibility -- Ember.js v4.12 or above -- Embroider or ember-auto-import v2 +- Ember.js v4.4 or above +- Ember CLI v4.4 or above ## Installation @@ -13,9 +23,9 @@ ember install ember-shepherd ``` -## Usage +## Documentation -[Longer description of how to use the addon in apps.] +[View Docs](https://robbiethewagner.github.io/ember-shepherd/) ## Contributing