Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BadhanGanesh authored Jan 20, 2020
1 parent 0ec8478 commit 728203c
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,20 @@

![BJOTPViewController Banner](banner.png)

![GitHub release (latest by date)](https://img.shields.io/github/v/release/BadhanGanesh/BJOTPViewController)
![GitHub pull requests](https://img.shields.io/github/issues-pr/BadhanGanesh/BJOTPViewController)
![GitHub issues](https://img.shields.io/github/issues/BadhanGanesh/BJOTPViewController)
![GitHub top language](https://img.shields.io/github/languages/top/BadhanGanesh/BJOTPViewController?color=green)
![GitHub](https://img.shields.io/github/license/BadhanGanesh/BJOTPViewController)

![StackOverflow Profile](https://img.shields.io/static/v1?label=Profile&message=StackOverflow&color=orange&link=https://stackoverflow.com/users/5912335/badhanganesh?tab=profile)
![Twitter Follow](https://img.shields.io/twitter/follow/badhanganesh?style=social)

A very simple and neat-looking view controller that lets you type in OTP's quick and easy.

This is intended to be a drag and drop view controller that gets the work done quickly, in and out, that's it. No fancy customizations, no cluttering the screen with tons of UI elements and crazy colors. You'll be good to go with the default settings.


## Supports

✅ iOS 9.0+
Expand All @@ -16,8 +26,17 @@ This is intended to be a drag and drop view controller that gets the work done q

✅ Portrait | Landscape


## Features

✅ Keyboard handling

✅ Copy-Paste handling

✅ Light mode | Dark mode

✅ Apple-inspired Clean User Interface


## Installation

Expand All @@ -34,6 +53,7 @@ This is intended to be a drag and drop view controller that gets the work done q
-----
![App Screens 2](app_screens_2.png)


## Usage

**Presentation**
Expand Down Expand Up @@ -83,15 +103,22 @@ oneTimePasswordVC.currentTextFieldColor = UIColor.systemOrange
oneTimePasswordVC.authenticateButtonColor = UIColor.systemGreen
```


## Upcoming Features

- Support for Mac Catalyst.
- Auto-completion of One Time Password into text fields from messages app.
- Addition of custom header / footer texts / description titles to the view controller.
- Addition of custom header text / footer text / description title to the view controller.
- Auto-completion of One Time Password from clipboard when copied from authenticator apps like **Google Authenticator**.


## Contribution

- Pull Requests are always welcome. 😇
- Feel free to create issues, if any, and improve the existing codebase.
- Feel free to create GitHub Issues when you face any problem, or for new feature-requests.
- Please follow [GitFlow](https://nvie.com/posts/a-successful-git-branching-model/) for raising PR's.

Thanks for checking out, and thanks for your contribution.

## License

Expand Down

0 comments on commit 728203c

Please sign in to comment.