Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

- v2 #24

Merged
merged 1 commit into from
Mar 18, 2024
Merged

- v2 #24

Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,13 @@ The Laravel AIssue package provides a comprehensive solution for managing issues
You can install the package via composer:

```bash
bashCopy code
composer require aurorawebsolutions/aissue
composer require aurorawebsoftware/aissue

```

After installation, publish and run the migrations with:

```bash
bashCopy code
php artisan vendor:publish --provider="AuroraWebSoftware\AIssue\AIssueServiceProvider" --tag="migrations"
php artisan migrate

Expand All @@ -44,7 +42,6 @@ Before diving into the code, it's essential to understand the main components of
Create a new issue:

```php
phpCopy code
use AuroraWebSoftware\AIssue\Models\AIssue;

$issue = AIssue::create([
Expand All @@ -60,7 +57,6 @@ $issue->applyWorkflow('simple');
Add actors to an issue:

```php
phpCopy code
// Assuming $user1 and $user2 are instances of a Model that implements IssueActorModelContract
$issue->setReporter($user1); // Set the reporter
$issue->setResponsible($user2); // Set the responsible party
Expand All @@ -70,7 +66,6 @@ $issue->setResponsible($user2); // Set the responsible party
Manage issue states:

```php
phpCopy code
// Transition to another state
$issue->transitionTo('state2');

Expand All @@ -82,7 +77,6 @@ $currentState = $issue->currentState();
### **Working with Connectives and Observers**

```php
phpCopy code
// Add observers to an issue
$issue->addObserver($user3);
$issue->addObserver($user4);
Expand All @@ -98,7 +92,6 @@ $issue->removeAllObservers();
### **Setting and Managing Due Dates**

```php
phpCopy code
use Illuminate\Support\Carbon;

// Set a due date for the issue
Expand Down