summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntonio Carlos Ribeiro <acr@antoniocarlosribeiro.com>2016-07-17 21:02:05 -0300
committerGitHub <noreply@github.com>2016-07-17 21:02:05 -0300
commit1f3c6799e2529b91bf655e970173effe72544d27 (patch)
tree0cda3779029cbe3318445572b7064f39536da065
parent2f22e1b6f2f7af49d2bd7c5fae5dbc4520606df2 (diff)
downloadgoogle2fa-example-1f3c6799e2529b91bf655e970173effe72544d27.zip
google2fa-example-1f3c6799e2529b91bf655e970173effe72544d27.tar.gz
google2fa-example-1f3c6799e2529b91bf655e970173effe72544d27.tar.bz2
Create a proper readme
-rw-r--r--readme.md28
1 files changed, 4 insertions, 24 deletions
diff --git a/readme.md b/readme.md
index 7f8816d..0f613fa 100644
--- a/readme.md
+++ b/readme.md
@@ -1,27 +1,7 @@
-# Laravel PHP Framework
+# Google2FA Example App
-[![Build Status](https://travis-ci.org/laravel/framework.svg)](https://travis-ci.org/laravel/framework)
-[![Total Downloads](https://poser.pugx.org/laravel/framework/d/total.svg)](https://packagist.org/packages/laravel/framework)
-[![Latest Stable Version](https://poser.pugx.org/laravel/framework/v/stable.svg)](https://packagist.org/packages/laravel/framework)
-[![Latest Unstable Version](https://poser.pugx.org/laravel/framework/v/unstable.svg)](https://packagist.org/packages/laravel/framework)
-[![License](https://poser.pugx.org/laravel/framework/license.svg)](https://packagist.org/packages/laravel/framework)
+The purpose of this app is to show how to use the [Google2FA](https://github.com/antonioribeiro/google2fa) package.
-Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Laravel attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as authentication, routing, sessions, queueing, and caching.
+After installing it, you should see a page like this:
-Laravel is accessible, yet powerful, providing tools needed for large, robust applications. A superb inversion of control container, expressive migration system, and tightly integrated unit testing support give you the tools you need to build any application with which you are tasked.
-
-## Official Documentation
-
-Documentation for the framework can be found on the [Laravel website](http://laravel.com/docs).
-
-## Contributing
-
-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](http://laravel.com/docs/contributions).
-
-## Security Vulnerabilities
-
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell at taylor@laravel.com. All security vulnerabilities will be promptly addressed.
-
-## License
-
-The Laravel framework is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).
+![](https://i.imgur.com/Q0SRguH.png)