You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

79 lines
2.8 KiB

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