|
| 1 | +**@FIXME:** |
| 2 | + |
| 3 | +- [ ] Generate a changelog |
| 4 | + `github_changelog_generator -u pdsinterop -p {{project-slug}}` |
| 5 | + |
| 6 | +# Solid Auth |
| 7 | + |
| 8 | +[![Project stage: Development][project-stage-badge: Development]][project-stage-page] |
| 9 | +[![License][license-shield]][license-link] |
| 10 | +[![Latest Version][version-shield]][version-link] |
| 11 | +![Maintained][maintained-shield] |
| 12 | + |
| 13 | +[![PDS Interop][pdsinterop-shield]][pdsinterop-site] |
| 14 | +[![standard-readme compliant][standard-readme-shield]][standard-readme-link] |
| 15 | +[![keep-a-changelog compliant][keep-a-changelog-shield]][keep-a-changelog-link] |
| 16 | + |
| 17 | +_OAuth2, OpenID and OIDC for Solid Server implementations_ |
| 18 | + |
| 19 | +This project contains a glue layer to `league/oauth2-server` and custom code to |
| 20 | +provide responses to all authentication and authorization requests made to a |
| 21 | +Solid Server that require OAuth2, OpenID Connect, or meta-data for either. |
| 22 | + |
| 23 | +## Table of Contents |
| 24 | + |
| 25 | +<!-- toc --> |
| 26 | + |
| 27 | +- [Installation](#installation) |
| 28 | +- [Usage](#usage) |
| 29 | +- [API](#api) |
| 30 | +- [Contribute](#contribute) |
| 31 | +- [License](#license) |
| 32 | + |
| 33 | +<!-- tocstop --> |
| 34 | + |
| 35 | +## Installation |
| 36 | + |
| 37 | +The advised install method is through composer: |
| 38 | + |
| 39 | +``` |
| 40 | +composer require pdsinterop/solid-auth |
| 41 | +``` |
| 42 | + |
| 43 | +PHP version 7.2 and higher is supported. The [`mbstring`](https://www.php.net/manual/en/book.mbstring.php) |
| 44 | +and [`json`](https://www.php.net/manual/en/book.json.php) extensions need to be |
| 45 | +enabled in order for this package to work. |
| 46 | + |
| 47 | +## Usage |
| 48 | + |
| 49 | +The functionality provided by this package is exposed mostly through these classes: |
| 50 | + |
| 51 | + @TODO: Add required code block illustrating how to use |
| 52 | + |
| 53 | +- @TODO: List main classes |
| 54 | + |
| 55 | +See the "API" section for detailed usage examples. |
| 56 | + |
| 57 | +## API |
| 58 | + |
| 59 | + @TODO: List API per class |
| 60 | + |
| 61 | +## Contribute |
| 62 | + |
| 63 | +Questions or feedback can be given by [opening an issue on GitHub][issues-link]. |
| 64 | + |
| 65 | +All PDS Interop projects are open source and community-friendly. |
| 66 | +Any contribution is welcome! |
| 67 | +For more details read the [contribution guidelines][contributing-link]. |
| 68 | + |
| 69 | +All PDS Interop projects adhere to [the Code Manifesto](http://codemanifesto.com) |
| 70 | +as its [code-of-conduct][code-of-conduct]. Contributors are expected to abide by its terms. |
| 71 | + |
| 72 | +There is [a list of all contributors on GitHub][contributors-page]. |
| 73 | + |
| 74 | +For a list of changes see the [CHANGELOG][changelog] or [the GitHub releases page][releases-page]. |
| 75 | + |
| 76 | +## License |
| 77 | + |
| 78 | +All code created by PDS Interop is licensed under the [MIT License][license-link]. |
| 79 | + |
| 80 | +[changelog]: CHANGELOG.md |
| 81 | +[code-of-conduct]: CODE_OF_CONDUCT.md |
| 82 | +[contributing-link]: CONTRIBUTING.md |
| 83 | +[contributors-page]: https://github.com/pdsinterop/php-solid-auth/contributors |
| 84 | +[issues-link]: https://github.com/pdsinterop/php-solid-auth/issues |
| 85 | +[releases-page]: https://github.com/pdsinterop/php-solid-auth/releases |
| 86 | +[keep-a-changelog-link]: https://keepachangelog.com/ |
| 87 | +[keep-a-changelog-shield]: https://img.shields.io/badge/Keep%20a%20Changelog-f15d30.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9IiNmZmYiIHZpZXdCb3g9IjAgMCAxODcgMTg1Ij48cGF0aCBkPSJNNjIgN2MtMTUgMy0yOCAxMC0zNyAyMmExMjIgMTIyIDAgMDAtMTggOTEgNzQgNzQgMCAwMDE2IDM4YzYgOSAxNCAxNSAyNCAxOGE4OSA4OSAwIDAwMjQgNCA0NSA0NSAwIDAwNiAwbDMtMSAxMy0xYTE1OCAxNTggMCAwMDU1LTE3IDYzIDYzIDAgMDAzNS01MiAzNCAzNCAwIDAwLTEtNWMtMy0xOC05LTMzLTE5LTQ3LTEyLTE3LTI0LTI4LTM4LTM3QTg1IDg1IDAgMDA2MiA3em0zMCA4YzIwIDQgMzggMTQgNTMgMzEgMTcgMTggMjYgMzcgMjkgNTh2MTJjLTMgMTctMTMgMzAtMjggMzhhMTU1IDE1NSAwIDAxLTUzIDE2bC0xMyAyaC0xYTUxIDUxIDAgMDEtMTItMWwtMTctMmMtMTMtNC0yMy0xMi0yOS0yNy01LTEyLTgtMjQtOC0zOWExMzMgMTMzIDAgMDE4LTUwYzUtMTMgMTEtMjYgMjYtMzMgMTQtNyAyOS05IDQ1LTV6TTQwIDQ1YTk0IDk0IDAgMDAtMTcgNTQgNzUgNzUgMCAwMDYgMzJjOCAxOSAyMiAzMSA0MiAzMiAyMSAyIDQxLTIgNjAtMTRhNjAgNjAgMCAwMDIxLTE5IDUzIDUzIDAgMDA5LTI5YzAtMTYtOC0zMy0yMy01MWE0NyA0NyAwIDAwLTUtNWMtMjMtMjAtNDUtMjYtNjctMTgtMTIgNC0yMCA5LTI2IDE4em0xMDggNzZhNTAgNTAgMCAwMS0yMSAyMmMtMTcgOS0zMiAxMy00OCAxMy0xMSAwLTIxLTMtMzAtOS01LTMtOS05LTEzLTE2YTgxIDgxIDAgMDEtNi0zMiA5NCA5NCAwIDAxOC0zNSA5MCA5MCAwIDAxNi0xMmwxLTJjNS05IDEzLTEzIDIzLTE2IDE2LTUgMzItMyA1MCA5IDEzIDggMjMgMjAgMzAgMzYgNyAxNSA3IDI5IDAgNDJ6bS00My03M2MtMTctOC0zMy02LTQ2IDUtMTAgOC0xNiAyMC0xOSAzN2E1NCA1NCAwIDAwNSAzNGM3IDE1IDIwIDIzIDM3IDIyIDIyLTEgMzgtOSA0OC0yNGE0MSA0MSAwIDAwOC0yNCA0MyA0MyAwIDAwLTEtMTJjLTYtMTgtMTYtMzEtMzItMzh6bS0yMyA5MWgtMWMtNyAwLTE0LTItMjEtN2EyNyAyNyAwIDAxLTEwLTEzIDU3IDU3IDAgMDEtNC0yMCA2MyA2MyAwIDAxNi0yNWM1LTEyIDEyLTE5IDI0LTIxIDktMyAxOC0yIDI3IDIgMTQgNiAyMyAxOCAyNyAzM3MtMiAzMS0xNiA0MGMtMTEgOC0yMSAxMS0zMiAxMXptMS0zNHYxNGgtOFY2OGg4djI4bDEwLTEwaDExbC0xNCAxNSAxNyAxOEg5NnoiLz48L3N2Zz4K |
| 88 | +[license-link]: ./LICENSE |
| 89 | +[license-shield]: https://img.shields.io/github/license/pdsinterop/php-solid-auth.svg |
| 90 | +[maintained-shield]: https://img.shields.io/maintenance/yes/2020.svg |
| 91 | +[pdsinterop-shield]: https://img.shields.io/badge/-PDS%20Interop-gray.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9Ii01IC01IDExMCAxMTAiIGZpbGw9IiNGRkYiIHN0cm9rZS13aWR0aD0iMCI+CiAgICA8cGF0aCBkPSJNLTEgNTJoMTdhMzcuNSAzNC41IDAgMDAyNS41IDMxLjE1di0xMy43NWEyMC43NSAyMSAwIDAxOC41LTQwLjI1IDIwLjc1IDIxIDAgMDE4LjUgNDAuMjV2MTMuNzVhMzcgMzQuNSAwIDAwMjUuNS0zMS4xNWgxN2EyMiAyMS4xNSAwIDAxLTEwMiAweiIvPgogICAgPHBhdGggZD0iTSAxMDEgNDhhMi43NyAyLjY3IDAgMDAtMTAyIDBoIDE3YTIuOTcgMi44IDAgMDE2OCAweiIvPgo8L3N2Zz4K |
| 92 | +[pdsinterop-site]: https://pdsinterop.org/ |
| 93 | +[project-stage-badge: Development]: https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg |
| 94 | +[project-stage-page]: https://blog.pother.ca/project-stages/ |
| 95 | +[standard-readme-link]: https://github.com/RichardLitt/standard-readme |
| 96 | +[standard-readme-shield]: https://img.shields.io/badge/-Standard%20Readme-brightgreen.svg |
| 97 | +[version-link]: https://packagist.org/packages/pdsinterop/php-solid-auth |
| 98 | +[version-shield]: https://img.shields.io/github/v/release/pdsinterop/php-solid-auth.svg?sort=semver |
0 commit comments