Skip to content

Latest commit

 

History

History
163 lines (122 loc) · 5.5 KB

README.md

File metadata and controls

163 lines (122 loc) · 5.5 KB

Contributors Forks Stargazers Issues MIT License


Vehicle.Faker Logo

Vehicle.Faker

A PHPFaker provider for generating vehicle information like registrations, car makes and car models.

Getting Started · Report Bug · Request Feature

Table of Contents
  1. Getting Started
  2. Usage
  3. Roadmap
  4. Contributing
  5. License
  6. Acknowledgments

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

Install the package with Composer

composer require carlwhittick/vehicle.faker

Add the provider to Faker

$faker = \Faker\Factory::create();
$faker->addProvider(new \CarlWhittick\Faker\Vehicle\Provider($faker));

(back to top)

Usage

$faker = \Faker\Factory::create();
$faker->addProvider(new \CarlWhittick\Faker\Vehicle\Provider($faker));

echo $faker->make(); // Ford
echo $faker->model(); // Mondeo
echo $faker->model('BMW'); // 3 series

echo $faker->registration('current'); // AB19 ETG
echo $faker->registration('military'); // 11AE22 
echo $faker->registration('diplomatic'); // 101D454 
echo $faker->registration('prefix'); // P311 LVW

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Install nix package manager.
  2. Fork the Project
  3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  4. Make your changes.
  5. Run nix develop at the root.
  6. Ensure that tests pass with vendor/bin/phpunit.
  7. Commit your Changes (git commit -m 'Add some AmazingFeature')
  8. Push to the Branch (git push origin feature/AmazingFeature)
  9. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

(back to top)