Skip to content

Commit

Permalink
updated the ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
rockblings committed Jun 14, 2023
1 parent 10f0a65 commit 2a1f614
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 2 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Changelog

All notable changes to `laravel-secure-random-number-generator` will be documented in this file.

## 0.0.1 - 2023-06-14

- initial release
63 changes: 62 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,63 @@
# laravel-secure-random-number-generator
A handy package to generate a secure unique random number for a model

[![Latest Version on Packagist](https://img.shields.io/packagist/v/creativecrafts/laravel-secure-random-number-generator.svg?style=flat-square)](https://packagist.org/packages/creativecrafts/laravel-secure-random-number-generator)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/creativecrafts/laravel-secure-random-number-generator/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/creativecrafts/laravel-secure-random-number-generator/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/creativecrafts/laravel-secure-random-number-generator/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/creativecrafts/laravel-secure-random-number-generator/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/creativecrafts/laravel-secure-random-number-generator.svg?style=flat-square)](https://packagist.org/packages/creativecrafts/laravel-secure-random-number-generator)


A handy package to generate a secure unique random number for a model.

## Installation

You can install the package via composer:

```bash
composer require creativecrafts/laravel-secure-random-number-generator
```

You can publish the config file with:

```bash
php artisan vendor:publish --tag="laravel-secure-random-number-generator"
```

This is the contents of the published config file:

```php
return [
];
```

## Usage

```php

```

## Testing

```bash
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

- [Godspower Oduose](https://github.com/rockblings)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
2 changes: 1 addition & 1 deletion phpstan.neon.dist
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ includes:
- phpstan-baseline.neon

parameters:
level: 4
level: 9
paths:
- src
- config
Expand Down

0 comments on commit 2a1f614

Please sign in to comment.