79 lines
2.8 KiB
Markdown
79 lines
2.8 KiB
Markdown
# ramsey/uuid
|
|
|
|
[![Source Code][badge-source]][source]
|
|
[![Latest Version][badge-release]][release]
|
|
[![Software License][badge-license]][license]
|
|
[![PHP Version][badge-php]][php]
|
|
[![Build Status][badge-build]][build]
|
|
[![Coverage Status][badge-coverage]][coverage]
|
|
[![Total Downloads][badge-downloads]][downloads]
|
|
|
|
ramsey/uuid is a PHP library for generating and working with universally unique
|
|
identifiers (UUIDs).
|
|
|
|
This project adheres to a [Contributor Code of Conduct][conduct]. By
|
|
participating in this project and its community, you are expected to uphold this
|
|
code.
|
|
|
|
Much inspiration for this library came from the [Java][javauuid] and
|
|
[Python][pyuuid] UUID libraries.
|
|
|
|
|
|
## Installation
|
|
|
|
The preferred method of installation is via [Composer][]. Run the following
|
|
command to install the package and add it as a requirement to your project's
|
|
`composer.json`:
|
|
|
|
```bash
|
|
composer require ramsey/uuid
|
|
```
|
|
|
|
|
|
## Upgrading to Version 4
|
|
|
|
See the documentation for a thorough upgrade guide:
|
|
|
|
* [Upgrading ramsey/uuid Version 3 to 4](https://uuid.ramsey.dev/en/latest/upgrading/3-to-4.html)
|
|
|
|
|
|
## Documentation
|
|
|
|
Please see <https://uuid.ramsey.dev> for documentation, tips, examples, and
|
|
frequently asked questions.
|
|
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Please read [CONTRIBUTING.md][] for details.
|
|
|
|
|
|
## Copyright and License
|
|
|
|
The ramsey/uuid library is copyright © [Ben Ramsey](https://benramsey.com/) and
|
|
licensed for use under the MIT License (MIT). Please see [LICENSE][] for more
|
|
information.
|
|
|
|
|
|
[rfc4122]: http://tools.ietf.org/html/rfc4122
|
|
[conduct]: https://github.com/ramsey/uuid/blob/master/.github/CODE_OF_CONDUCT.md
|
|
[javauuid]: http://docs.oracle.com/javase/6/docs/api/java/util/UUID.html
|
|
[pyuuid]: http://docs.python.org/3/library/uuid.html
|
|
[composer]: http://getcomposer.org/
|
|
[contributing.md]: https://github.com/ramsey/uuid/blob/master/.github/CONTRIBUTING.md
|
|
|
|
[badge-source]: https://img.shields.io/badge/source-ramsey/uuid-blue.svg?style=flat-square
|
|
[badge-release]: https://img.shields.io/packagist/v/ramsey/uuid.svg?style=flat-square&label=release
|
|
[badge-license]: https://img.shields.io/packagist/l/ramsey/uuid.svg?style=flat-square
|
|
[badge-php]: https://img.shields.io/packagist/php-v/ramsey/uuid.svg?style=flat-square
|
|
[badge-build]: https://img.shields.io/travis/ramsey/uuid/master.svg?style=flat-square
|
|
[badge-coverage]: https://img.shields.io/coveralls/github/ramsey/uuid/master.svg?style=flat-square
|
|
[badge-downloads]: https://img.shields.io/packagist/dt/ramsey/uuid.svg?style=flat-square&colorB=mediumvioletred
|
|
|
|
[source]: https://github.com/ramsey/uuid
|
|
[release]: https://packagist.org/packages/ramsey/uuid
|
|
[license]: https://github.com/ramsey/uuid/blob/master/LICENSE
|
|
[php]: https://php.net
|
|
[build]: https://travis-ci.org/ramsey/uuid
|
|
[coverage]: https://coveralls.io/github/ramsey/uuid?branch=master
|
|
[downloads]: https://packagist.org/packages/ramsey/uuid
|