Skip to content

Commit

Permalink
Merge pull request #33 from michalsn/docs-composer
Browse files Browse the repository at this point in the history
docs: add composer minimum-stability instructions
  • Loading branch information
michalsn committed Dec 29, 2023
2 parents 746d6e5 + 04b6b18 commit 3a4c5d3
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,31 @@ The only thing you have to do is to run this command, and you're ready to go.

composer require codeigniter4/queue

#### A composer error occurred?

If you get the following error:

```console
Could not find a version of package codeigniter4/queue matching your minimum-stability (stable).
Require it with an explicit version constraint allowing its desired stability.
```

1. Run the following commands to change your [minimum-stability](https://getcomposer.org/doc/articles/versions.md#minimum-stability) in your project `composer.json`:

```console
composer config minimum-stability dev
composer config prefer-stable true
```

2. Or specify an explicit version:

```console
composer require codeigniter4/queue:dev-develop
```

The above specifies `develop` branch.
See <https://getcomposer.org/doc/articles/versions.md#branches>

## Manual Installation

In the example below we will assume, that files from this project will be located in `app/ThirdParty/queue` directory.
Expand Down
4 changes: 4 additions & 0 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@
If you want to assign an object to the queue, please make sure it implements `JsonSerializable` interface. This is how CodeIgniter [Entities](https://codeigniter.com/user_guide/models/entities.html) are handled by default.

You may ask, why not just use `serialize` and `unserialize`? There are security reasons that keep us from doing so. These functions are not safe to use with user provided data.

### I get an error when trying to install via composer.

Please see these [instructions](installation.md/#a-composer-error-occurred).

0 comments on commit 3a4c5d3

Please sign in to comment.