| 1 |
<h1 align="center">ramsey/uuid</h1> |
| 2 |
|
| 3 |
<p align="center"> |
| 4 |
<strong>A PHP library for generating and working with UUIDs.</strong> |
| 5 |
</p> |
| 6 |
|
| 7 |
<p align="center"> |
| 8 |
<a href="https://github.com/ramsey/uuid"><img src="http://img.shields.io/badge/source-ramsey/uuid-blue.svg?style=flat-square" alt="Source Code"></a> |
| 9 |
<a href="https://packagist.org/packages/ramsey/uuid"><img src="https://img.shields.io/packagist/v/ramsey/uuid.svg?style=flat-square&label=release" alt="Download Package"></a> |
| 10 |
<a href="https://php.net"><img src="https://img.shields.io/packagist/php-v/ramsey/uuid.svg?style=flat-square&colorB=%238892BF" alt="PHP Programming Language"></a> |
| 11 |
<a href="https://github.com/ramsey/uuid/blob/main/LICENSE"><img src="https://img.shields.io/packagist/l/ramsey/uuid.svg?style=flat-square&colorB=darkcyan" alt="Read License"></a> |
| 12 |
<a href="https://github.com/ramsey/uuid/actions/workflows/continuous-integration.yml"><img src="https://img.shields.io/github/workflow/status/ramsey/uuid/build/main?logo=github&style=flat-square" alt="Build Status"></a> |
| 13 |
<a href="https://codecov.io/gh/ramsey/uuid"><img src="https://img.shields.io/codecov/c/gh/ramsey/uuid?label=codecov&logo=codecov&style=flat-square" alt="Codecov Code Coverage"></a> |
| 14 |
<a href="https://shepherd.dev/github/ramsey/uuid"><img src="https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fshepherd.dev%2Fgithub%2Framsey%2Fuuid%2Fcoverage" alt="Psalm Type Coverage"></a> |
| 15 |
</p> |
| 16 |
|
| 17 |
ramsey/uuid is a PHP library for generating and working with universally unique |
| 18 |
identifiers (UUIDs). |
| 19 |
|
| 20 |
This project adheres to a [](CODE_OF_CONDUCT.mdcode of conduct](CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). |
| 21 |
By participating in this project and its community, you are expected to |
| 22 |
uphold this code. |
| 23 |
|
| 24 |
Much inspiration for this library came from the [Java][javauuid] and |
| 25 |
[Python][pyuuid] UUID libraries. |
| 26 |
|
| 27 |
## Installation |
| 28 |
|
| 29 |
The preferred method of installation is via [Composer][]. Run the following |
| 30 |
command to install the package and add it as a requirement to your project's |
| 31 |
`composer.json`: |
| 32 |
|
| 33 |
```bash |
| 34 |
composer require ramsey/uuid |
| 35 |
``` |
| 36 |
|
| 37 |
## Upgrading to Version 4 |
| 38 |
|
| 39 |
See the documentation for a thorough upgrade guide: |
| 40 |
|
| 41 |
* [](https://uuid.ramsey.dev/en/latest/upgrading/3-to-4.htmlUpgrading ramsey/uuid Version 3 to 4](https://uuid.ramsey.dev/en/latest/upgrading/3-to-4.html](https://uuid.ramsey.dev/en/latest/upgrading/3-to-4.html) |
| 42 |
|
| 43 |
## Documentation |
| 44 |
|
| 45 |
Please see <https://uuid.ramsey.dev> for documentation, tips, examples, and |
| 46 |
frequently asked questions. |
| 47 |
|
| 48 |
## Contributing |
| 49 |
|
| 50 |
Contributions are welcome! To contribute, please familiarize yourself with |
| 51 |
[](CONTRIBUTING.mdCONTRIBUTING.md](CONTRIBUTING.md](CONTRIBUTING.md). |
| 52 |
|
| 53 |
## Coordinated Disclosure |
| 54 |
|
| 55 |
Keeping user information safe and secure is a top priority, and we welcome the |
| 56 |
contribution of external security researchers. If you believe you've found a |
| 57 |
security issue in software that is maintained in this repository, please read |
| 58 |
[SECURITY.md][] for instructions on submitting a vulnerability report. |
| 59 |
|
| 60 |
## ramsey/uuid for Enterprise |
| 61 |
|
| 62 |
Available as part of the Tidelift Subscription. |
| 63 |
|
| 64 |
The maintainers of ramsey/uuid and thousands of other packages are working with |
| 65 |
Tidelift to deliver commercial support and maintenance for the open source |
| 66 |
packages you use to build your applications. Save time, reduce risk, and improve |
| 67 |
code health, while paying the maintainers of the exact packages you use. |
| 68 |
[](https://tidelift.com/subscription/pkg/packagist-ramsey-uuid?utm_source=undefined&utm_medium=referral&utm_campaign=enterprise&utm_term=repoLearn more.](https://tidelift.com/subscription/pkg/packagist-ramsey-uuid?utm_source=undefined&utm_medium=referral&utm_campaign=enterprise&utm_term=repo](https://tidelift.com/subscription/pkg/packagist-ramsey-uuid?utm_source=undefined&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) |
| 69 |
|
| 70 |
## Copyright and License |
| 71 |
|
| 72 |
The ramsey/uuid library is copyright © [](https://benramsey.com/Ben Ramsey](https://benramsey.com/](https://benramsey.com/) and |
| 73 |
licensed for use under the MIT License (MIT). Please see [LICENSE][] for more |
| 74 |
information. |
| 75 |
|
| 76 |
[rfc4122]: http://tools.ietf.org/html/rfc4122 |
| 77 |
[conduct]: https://github.com/ramsey/uuid/blob/main/CODE_OF_CONDUCT.md |
| 78 |
[javauuid]: http://docs.oracle.com/javase/6/docs/api/java/util/UUID.html |
| 79 |
[pyuuid]: http://docs.python.org/3/library/uuid.html |
| 80 |
[composer]: http://getcomposer.org/ |
| 81 |
[contributing.md]: https://github.com/ramsey/uuid/blob/main/CONTRIBUTING.md |
| 82 |
[security.md]: https://github.com/ramsey/uuid/blob/main/SECURITY.md |
| 83 |
[license]: https://github.com/ramsey/uuid/blob/main/LICENSE |
| 84 |
|
