passforios/README.md

<img src="icon/icon_round.png" width="76"/> 

# Pass
[![GitHub release](https://img.shields.io/github/release/mssun/pass-ios.svg)](https://github.com/mssun/pass-ios/releases)
![Swift 3.1](https://img.shields.io/badge/Swift-3.1-orange.svg)
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/passforios/passforios)
[![Build Status](https://travis-ci.org/mssun/passforios.svg?branch=develop)](https://travis-ci.org/mssun/passforios)
[![Donate](https://img.shields.io/badge/Paypal-donate-blue.svg)](https://www.paypal.me/mssun)

Pass is an iOS client compatible with [ZX2C4's Pass command line
application](http://www.passwordstore.org/).  It is a password manager using
GPG for encryption and Git for version control.

Pass for iOS is available in the [App Store](https://appsto.re/us/DY13hb.i)
with the name "Pass - Password Store".  If you want to join the iOS beta via 
Testflight, drop an email to `developer@passforios.mssun.me`. Thank you.

## Features

- Try to be compatible with the Password Store command line tool
- Support to view, copy, add, and edit password entries
- Encrypt and decrypt password entries by PGP keys
- Synchronize with your password Git repository
- User-friendly interface: search, long press to copy, copy and open link, etc.
- Support one-time password (OTP) tokens (QR code and otpauth URI)
- Written in Swift
- No need to jailbreak your devices

## Screenshots

<p>
<img src="screenshot/preview.gif" width="200"/>
<img src="screenshot/screenshot1.png" width="200"/>
<img src="screenshot/screenshot2.png" width="200"/>
<img src="screenshot/screenshot3.png" width="200"/>
</p>

## Usages

- Setup your password-store ([official `Pass` introduction](https://www.passwordstore.org/))
- Get Pass for iOS from the App Store or build one by yourself
- Start to use Pass for iOS on your iPhone/iPad ([quick-start guide](https://github.com/mssun/passforios/wiki#quick-start-guide-for-pass-for-ios))

For more, please read the [wiki page](https://github.com/mssun/pass-ios/wiki).

## Building Pass for iOS

1. Install libtool, automake, cmake, carthage, and cocoapods: `brew install
   libtool automake cmake carthage cocoapods`
2. Run carthage bootstrap in the project root directory: `carthage bootstrap
   --platform iOS` (this could take a long time to build related frameworks)
3. Run pod install in the project root directory: `pod install`
4. Open `.xcworkspace` file in Xcode.
5. Build & Run.

## License

MIT