Skip to content

Commit

Permalink
chore: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
frknasir committed Apr 19, 2022
1 parent ae9078f commit 47856d1
Showing 1 changed file with 12 additions and 26 deletions.
38 changes: 12 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,6 @@
# Introduction

[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/support-ukraine.svg?t=1" />](https://supportukrainenow.org)

# Manage contacts(e.g customers, suppliers, vendors etc) and addresses in your laravel applications.

[![Latest Version on Packagist](https://img.shields.io/packagist/v/starfolksoftware/ally.svg?style=flat-square)](https://packagist.org/packages/starfolksoftware/ally)
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/starfolksoftware/ally/run-tests?label=tests)](https://github.com/starfolksoftware/ally/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/starfolksoftware/ally/Check%20&%20fix%20styling?label=code%20style)](https://github.com/starfolksoftware/ally/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/starfolksoftware/ally.svg?style=flat-square)](https://packagist.org/packages/starfolksoftware/ally)

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

## Support us

[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/ally.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/ally)

We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
Manage contacts(e.g customers, suppliers, vendors etc) and addresses in your laravel applications.

## Installation

Expand All @@ -42,21 +26,23 @@ php artisan vendor:publish --tag="ally-config"
This is the contents of the published config file:

```php
<?php
// config for StarfolkSoftware/Ally
return [
];
```

Optionally, you can publish the views using
'middleware' => ['web'],

```bash
php artisan vendor:publish --tag="ally-views"
'redirects' => [
'store' => null,
'update' => null,
'destroy' => '/',
],
];
```

## Usage

```php
$ally = new StarfolkSoftware\Ally();
echo $ally->echoPhrase('Hello, StarfolkSoftware!');

```

## Testing
Expand Down

0 comments on commit 47856d1

Please sign in to comment.