README.rst 977 B

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. uritemplate
  2. ===========
  3. `uritemplate`_ is a Go implementation of `URI Template`_ [RFC6570] with
  4. full functionality of URI Template Level 4.
  5. uritemplate can also generate a regexp that matches expansion of the
  6. URI Template from a URI Template.
  7. Getting Started
  8. ---------------
  9. Installation
  10. ~~~~~~~~~~~~
  11. .. code-block:: sh
  12. $ go get -u github.com/yosida95/uritemplate/v3
  13. Documentation
  14. ~~~~~~~~~~~~~
  15. The documentation is available on GoDoc_.
  16. Examples
  17. --------
  18. See `examples on GoDoc`_.
  19. License
  20. -------
  21. `uritemplate`_ is distributed under the BSD 3-Clause license.
  22. PLEASE READ ./LICENSE carefully and follow its clauses to use this software.
  23. Author
  24. ------
  25. yosida95_
  26. .. _`URI Template`: https://tools.ietf.org/html/rfc6570
  27. .. _Godoc: https://godoc.org/github.com/yosida95/uritemplate
  28. .. _`examples on GoDoc`: https://godoc.org/github.com/yosida95/uritemplate#pkg-examples
  29. .. _yosida95: https://yosida95.com/
  30. .. _uritemplate: https://github.com/yosida95/uritemplate