1# ramsey/uuid
  2
  3[![Source Code][badge-source]][source]
  4[![Latest Version][badge-release]][release]
  5[![Software License][badge-license]][license]
  6[![PHP Version][badge-php]][php]
  7[![Build Status][badge-build]][build]
  8[![Coverage Status][badge-coverage]][coverage]
  9[![Total Downloads][badge-downloads]][downloads]
 10
 11ramsey/uuid is a PHP library for generating and working with universally unique
 12identifiers (UUIDs).
 13
 14This project adheres to a [Contributor Code of Conduct][conduct]. By
 15participating in this project and its community, you are expected to uphold this
 16code.
 17
 18Much inspiration for this library came from the [Java][javauuid] and
 19[Python][pyuuid] UUID libraries.
 20
 21
 22## Installation
 23
 24The preferred method of installation is via [Composer][]. Run the following
 25command to install the package and add it as a requirement to your project's
 26`composer.json`:
 27
 28```bash
 29composer require ramsey/uuid
 30```
 31
 32
 33## Upgrading to Version 4
 34
 35See the documentation for a thorough upgrade guide:
 36
 37* [Upgrading ramsey/uuid Version 3 to 4](https://uuid.ramsey.dev/en/latest/upgrading/3-to-4.html)
 38
 39
 40## Documentation
 41
 42Please see <https://uuid.ramsey.dev> for documentation, tips, examples, and
 43frequently asked questions.
 44
 45
 46## Contributing
 47
 48Contributions are welcome! Please read [CONTRIBUTING.md][] for details.
 49
 50
 51## Copyright and License
 52
 53The ramsey/uuid library is copyright © [Ben Ramsey](https://benramsey.com/) and
 54licensed for use under the MIT License (MIT). Please see [LICENSE][] for more
 55information.
 56
 57
 58[rfc4122]: http://tools.ietf.org/html/rfc4122
 59[conduct]: https://github.com/ramsey/uuid/blob/master/.github/CODE_OF_CONDUCT.md
 60[javauuid]: http://docs.oracle.com/javase/6/docs/api/java/util/UUID.html
 61[pyuuid]: http://docs.python.org/3/library/uuid.html
 62[composer]: http://getcomposer.org/
 63[contributing.md]: https://github.com/ramsey/uuid/blob/master/.github/CONTRIBUTING.md
 64
 65[badge-source]: https://img.shields.io/badge/source-ramsey/uuid-blue.svg?style=flat-square
 66[badge-release]: https://img.shields.io/packagist/v/ramsey/uuid.svg?style=flat-square&label=release
 67[badge-license]: https://img.shields.io/packagist/l/ramsey/uuid.svg?style=flat-square
 68[badge-php]: https://img.shields.io/packagist/php-v/ramsey/uuid.svg?style=flat-square
 69[badge-build]: https://img.shields.io/travis/ramsey/uuid/master.svg?style=flat-square
 70[badge-coverage]: https://img.shields.io/coveralls/github/ramsey/uuid/master.svg?style=flat-square
 71[badge-downloads]: https://img.shields.io/packagist/dt/ramsey/uuid.svg?style=flat-square&colorB=mediumvioletred
 72
 73[source]: https://github.com/ramsey/uuid
 74[release]: https://packagist.org/packages/ramsey/uuid
 75[license]: https://github.com/ramsey/uuid/blob/master/LICENSE
 76[php]: https://php.net
 77[build]: https://travis-ci.org/ramsey/uuid
 78[coverage]: https://coveralls.io/github/ramsey/uuid?branch=master
 79[downloads]: https://packagist.org/packages/ramsey/uuid
 80