docs/README.md
# Antares Two Factor Auth Module
[![Laravel 5.4](https://img.shields.io/badge/Laravel-5.4-orange.svg)](http://laravel.com)
[![Coverage Status](https://coveralls.io/repos/github/antaresproject/two_factor_auth/badge.svg?branch=0.9.2)](https://coveralls.io/github/antaresproject/two_factor_auth?branch=0.9.2)
[![Build Status](https://travis-ci.org/antaresproject/two_factor_auth.svg?branch=0.9.2)](https://travis-ci.org/antaresproject/two_factor_auth)
[![Code Climate](https://codeclimate.com/github/antaresproject/two_factor_auth/badges/gpa.svg)](https://codeclimate.com/github/antaresproject/two_factor_auth)
[![GitHub issues](https://img.shields.io/github/issues/antaresproject/two_factor_auth.svg)](https://github.com/antaresproject/two_factor_auth/issues)
[![GitHub forks](https://img.shields.io/github/forks/antaresproject/two_factor_auth.svg)](https://github.com/antaresproject/two_factor_auth/network)
[![GitHub stars](https://img.shields.io/github/stars/antaresproject/two_factor_auth.svg)](https://github.com/antaresproject/two_factor_auth/stargazers)
[![GitHub license](https://img.shields.io/badge/license-New%20BSD-blue.svg)](https://raw.githubusercontent.com/antaresproject/two_factor_auth/0.9.2/LICENSE)
Antares Two Factor Auth is a package which provides method of confirming a user's identity by utilizing two different authentication components. Implemented with Google and Yubikey authenticators.
![two_factor_auth](docs/img/two_factor_auth.PNG)
## Documentation
Antares Two Factor Auth Module documentation is not finished yet.
Full Antares documentation can be found at [docs.antaresproject.io/php-framework](http://www.docs.antaresproject.io/php-framework).
## Changelog
Antares Two Factor Auth changelog can be found in release notes [docs.antaresproject.io/php-framework/getting-started/changelog/#two-factor-auth](http://www.docs.antaresproject.io/php-framework/getting-started/changelog#two-factor-auth).
You can find full Antares changelog in Antares Documentation [docs.antaresproject.io/php-framework/getting-started/changelog](http://www.docs.antaresproject.io/php-framework/getting-started/changelog).
## Issues
The issue list of this repo is **exclusively** for bug reports and feature requests.
Please follow [Issue Reporting Guide](http://www.docs.antaresproject.io/php-framework/getting-started/issues-reporting-guide) before opening an issue. Issues not following the guide will be closed without further investigation.
## Contribution
Please follow [Contribution Guide](http://www.docs.antaresproject.io/php-framework/getting-started/contribution-guide) before making a pull request.
## Community
* Twitter: @antaresproject
* Forum: (coming soon)
* Blog: (coming soon)
* Email: contact (at) antaresproject.io
## License
This software is released under the BSD 3-Clause License.
© 2017 INBS.Software.