Add README.md and LICENSE

This commit is contained in:
Alice Gaudon 2019-06-01 16:32:01 +02:00
parent 119eafefcc
commit 015bdbd159
2 changed files with 36 additions and 0 deletions

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2019 Alice Gaudon
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# Identity DB
Updates your user's identities on login based on a custom database query.
Currently supports 1 column query results (email addresses).
## Configuration
Copy config.inc.php.dist to config.inc.php (or `ln`) and follow instructions for each configuration value.
## Contributing
Feel free to make a pull request if you improve this plugin.
You can include yourself in the author list of [composer.json](composer.json) or classes if you want, but you have to do it in your pull request. I won't add anyone to these lists by myself or accept requests/pull requests that only serve this purpose.
## License
See [License file](LICENSE)