Skip to content

Commit

Permalink
fixing .md
Browse files Browse the repository at this point in the history
  • Loading branch information
GeorgeFourkas committed Dec 3, 2022
1 parent 3c06bbe commit 03842ea
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 37 deletions.
87 changes: 51 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,12 @@
# This is my package apiautopilot

![image](https://apiautopilot.info/assets/images/aap_logo%20_cropped.png)

[![Latest Version on Packagist](https://img.shields.io/packagist/v/apiautopilot/apiautopilot.svg?style=flat-square)](https://packagist.org/packages/apiautopilot/apiautopilot)
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/apiautopilot/apiautopilot/run-tests?label=tests)](https://github.com/GeorgeFourkas/ApiAutoPilot/actions/workflows/run-tests.yml/badge.svg)
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/apiautopilot/apiautopilot/Fix%20PHP%20code%20style%20issues?label=code%20style)](https://github.com/apiautopilot/apiautopilot/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/apiautopilot/apiautopilot.svg?style=flat-square)](https://packagist.org/packages/apiautopilot/apiautopilot)

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/ApiAutoPilot.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/ApiAutoPilot)

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).
### **Api Auto Pilot** is laravel package that makes the procecess of creating laravel RESTful APIs a breeze!

## Installation

Expand All @@ -23,11 +16,10 @@ You can install the package via composer:
composer require apiautopilot/apiautopilot
```

You can publish and run the migrations with:
After you required the packager from packagist, make sure to run the installation command:

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

You can publish the config file with:
Expand All @@ -39,21 +31,55 @@ php artisan vendor:publish --tag="apiautopilot-config"
This is the contents of the published config file:

```php
<?php

return [
'index' => [
'exclude' => [

],
],
'show' => [
'exclude' => [

],
],
'create' => [
'exclude' => [

],
],
'update' => [
'exclude' => [

],
],
'delete' => [
'exclude' => [

],
],
'attach' => [
'exclude' => [

],
],
'detach' => [
'exclude' => [

],
],
'sync' => [
'exclude' => [

],
],

'settings' => [

],
];
```

Optionally, you can publish the views using

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

## Usage

```php
$apiAutoPilot = new ApiAutoPilot\ApiAutoPilot();
echo $apiAutoPilot->echoPhrase('Hello, ApiAutoPilot!');
```

## Testing
Expand All @@ -62,17 +88,6 @@ echo $apiAutoPilot->echoPhrase('Hello, ApiAutoPilot!');
composer test
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

Expand Down
2 changes: 1 addition & 1 deletion src/Commands/InstallationCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class InstallationCommand extends Command
" ApiAutoPilot\ApiAutoPilot\Facades\ApiAutoPilot::routes();".PHP_EOL.
'});'.PHP_EOL;

public $signature = 'autopilot:install';
public $signature = 'apiautopilot:install';

public $description = 'this command installs the package.';

Expand Down

0 comments on commit 03842ea

Please sign in to comment.