Skip to content

Commit

Permalink
Added a few lines to describe how to contribute
Browse files Browse the repository at this point in the history
Co-authored-by: Gennaro Landolfi <[email protected]>
  • Loading branch information
sebhd1 and rinodrummer committed Feb 23, 2024
1 parent 3ebe66f commit 9d09b04
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Common use cases for Squire include:
- [Model Relationships](#model-relationships)
- [Validation](#validation)
- [Creating your own Models](#creating-your-own-models)
- [Adding a localization](#adding-a-localization)
- [Upgrading from 1.x](#upgrading-from-1x)
- [Need Help?](#need-help)

Expand Down Expand Up @@ -467,6 +468,12 @@ class Language extends Rule

Squire models, their sources, and validation rules are all simply releasable in Composer packages. To see an example of this in action, check out the [`squirephp/countries`](https://github.com/squirephp/countries) and [`squirephp/countries-en`](https://github.com/squirephp/countries-en) packages.

## Adding a localization

If you wish to contribute to this package by adding a localization, feel free to make your own package(s) and take inspiration by the various sub-packages you can find in the organization repositories.

Once you've made your repository, publish it via [Packagist](https://packagist.org) and add your package to the specific table of the given category submitting a PR!

## Upgrading from 2.x

If you're using any validation rules, they are now all end with `Rule`. This allows both the model and rule to be imported into the same class without the use of aliasing:
Expand Down

0 comments on commit 9d09b04

Please sign in to comment.