From 2aadbace6ac6a741c0602e9f583a0b38a1852146 Mon Sep 17 00:00:00 2001
From: Bubka <858858+Bubka@users.noreply.github.com>
Date: Mon, 13 Jan 2020 16:39:27 +0100
Subject: [PATCH] Add readme.md file

---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..79978648
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+![Travis (.com)](https://img.shields.io/travis/com/bubka/2fauth?style=flat-square)
+
+# 2FAuth
+A web app to manage your Two-factors Auth (2FA) accounts and generate their TOTP tokens
+
+## Purpose
+2FAuth is an web based self-hosted alternative to One Time Passcode (OTP) generators like Google Authenticator that you can use both on mobile or desktop.
+
+I created it because :
+* Most of the UIs for this kind of apps show tokens for all accounts in the same time with stressful countdowns (in my opinion)
+* I wanted my 2FA accounts to be stored in a database I can easily backup and restore.
+* I hate taking out my smartphone to get an OTP when I'm at my desktop
+* I love self-hosted solution
+
+## Features
+* Manage your 2FA accounts (add, edit, delete), with QR code upload support
+* Generate tokens
+* User authentication to protect access to 2FA accounts
+
+#### Single user app
+2FA are sensitives data so it is necessary to sign in an user account in order to use the app. And because they are also owned by you only, it is not possible to create more than one account.
+
+## RFC compliance
+2FAuth generates OTP according to RFC 4226 (HOTP Algorithm) and RFC 6238 (TOTP Algorithm) thanks to [Spomky-Labs/OTPHP](https://github.com/Spomky-Labs/otphp) php library.
+
+## Requirements
+* [![Requires PHP7](https://img.shields.io/badge/php-7.*-red.svg?style=flat-square)](https://secure.php.net/downloads.php)
+* MySQL or SQLITE database
+
+## Installation (using command line)
+
+#### Clone the repo
+```
+git clone https://github.com/bubka/2fauth.git
+```
+
+#### Install all php dependencies
+```
+php composer.phar install
+```
+Don't have `composer`? [you can get it here](https://getcomposer.org/download/)
+
+#### Set your variables
+In your installation directory make a copy of the `.env.example` file and rename the copy `.env`.
+
+Edit the `.env` file and adapt the settings to your running environment (see instructions in the file)
+
+#### Prepare the database
+```
+php artisan migrate:refresh
+php artisan passport:install
+```
+
+# Contributing
+to complete
+
+# License
+[AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html)
\ No newline at end of file