passforios/README.md

60 lines
2.2 KiB
Markdown
Raw Normal View History

2017-02-15 15:49:26 +08:00
<img src="icon/icon_round.png" width="76"/>
2017-01-24 18:03:07 +08:00
2017-02-15 22:15:19 +08:00
# Pass
2017-02-12 10:41:14 +08:00
[![GitHub release](https://img.shields.io/github/release/mssun/pass-ios.svg)](https://github.com/mssun/pass-ios/releases)
2017-02-15 15:51:18 +08:00
![Swift 3.1](https://img.shields.io/badge/Swift-3.1-orange.svg)
2017-03-11 18:11:50 -08:00
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/passforios/passforios)
2017-03-26 21:37:37 -07:00
[![Build Status](https://travis-ci.org/mssun/passforios.svg?branch=develop)](https://travis-ci.org/mssun/passforios)
2017-02-06 00:29:14 +08:00
2017-02-15 22:15:19 +08:00
Pass is an iOS client compatible with [ZX2C4's Pass command line
2017-02-15 15:54:42 +08:00
application](http://www.passwordstore.org/). It is a password manager using
GPG for encryption and Git for version control.
2017-01-24 22:48:18 +08:00
2017-04-23 20:58:56 -07:00
Pass for iOS is under *TestFlight external testing*. Drop an email to
`developer@passforios.mssun.me` for testing. Thank you.
2017-02-17 21:55:40 +08:00
2017-02-16 15:47:00 +08:00
## Features
2017-03-25 00:31:48 +08:00
- Try to be compatible with the Password Store command line tool
2017-02-16 15:47:00 +08:00
- Support to view, copy, add, edit password entries
- Encrypt and decrypt password entries by PGP keys
2017-03-25 00:31:48 +08:00
- Synchronize with your password Git repository
2017-02-19 00:34:08 +08:00
- User-friendly interface: search, long press to copy, copy and open link, etc.
2017-04-28 21:16:56 -07:00
- Support one-time password (OTP) tokens (QR code and otpauth URI)
2017-02-16 15:47:00 +08:00
- Written in Swift
- No need to jailbreak your devices
2017-03-22 21:35:52 -07:00
- Get from App Store (stay tuned)
2017-02-16 15:47:00 +08:00
2017-02-06 00:49:23 +08:00
## Screenshots
2017-03-20 19:40:35 -07:00
<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>
2017-02-12 11:09:45 +08:00
2017-02-16 14:47:48 +08:00
## Build
2017-02-23 20:36:31 +08:00
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.
2017-02-16 14:47:48 +08:00
2017-02-12 11:09:45 +08:00
## Usage
2017-02-19 13:59:39 +00:00
- Generate a PGP key pair
2017-02-16 15:51:47 +08:00
- Use the `pass` command line tool
2017-02-19 22:14:17 +08:00
- Push encrypted password store to a private Git repository
2017-02-16 15:51:47 +08:00
- Build Pass for iOS by yourself or download from App Store
- Start to use Pass for iOS on your iPhone/iPad
2017-02-12 11:09:45 +08:00
For more, please read the [wiki page](https://github.com/mssun/pass-ios/wiki).
2017-02-12 11:12:30 +08:00
## License
MIT