Skip to content

Commit

Permalink
docs: remove placeholder text
Browse files Browse the repository at this point in the history
  • Loading branch information
bensherred committed Nov 27, 2023
1 parent b5f7abd commit ccfcabc
Showing 1 changed file with 2 additions and 18 deletions.
20 changes: 2 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/red-explosion/laravel-sqids/coding-standards.yml?label=code%20style&style=flat-square)](https://github.com/red-explosion/laravel-sqids/actions/workflows/coding-standards.yml?query=branch:main)
[![Total Downloads](https://img.shields.io/packagist/dt/red-explosion/laravel-sqids.svg?style=flat-square)](https://packagist.org/packages/red-explosion/laravel-sqids)

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

## Installation

Expand All @@ -15,31 +15,15 @@ You can install the package via composer:
composer require red-explosion/laravel-sqids
```

You can publish and run the migrations with:

```bash
php artisan vendor:publish --tag="sqids-migrations"
php artisan migrate
```

You can publish the config file with:

```bash
php artisan vendor:publish --tag="sqids-config"
```

Optionally, you can publish the views using

```bash
php artisan vendor:publish --tag="sqids-views"
```

## Usage

```php
$variable = new RedExplosion\Sqids();
echo $variable->echoPhrase('Hello, Red Explosion!');
```
...

## Testing

Expand Down

0 comments on commit ccfcabc

Please sign in to comment.