Android-Password-Store/README.md

PwdStore
========

This application tries to be 100% compatible with [pass](http://www.passwordstore.org/)

You can install the application from:

- [F-Droid](https://f-droid.org/repository/browse/?fdid=com.zeapo.pwdstore) (the prefered way)
- [Play Store](https://play.google.com/store/apps/details?id=com.zeapo.pwdstore) (always lags behind)
- Using the apk file found at `app/app-release.apk` or build everything from source (always updated before Play Store, but usually after F-Droid)

Community
=========

A few ways to get in touch:

- [Github issues](https://github.com/zeapo/Android-Password-Store/issues), use it if you have a bug report, you do not understand how somehting works or feature request
- IRC : on irc://chat.freenode.net/Android-Password-Store (that means channel #Android-Password-Store on freenode), some of us hangout there
- [reddit](https://www.reddit.com/r/androidpwd), want to discuss something and it's midnight, no one on irc and you really want to write more than a couple of lines? reddit is your way!

How-To
======
*Note:* This section is work in progress

Clone using SSH-key, then decrypt a password
--------------------------------------------

<img src="tutorial_clone_ssh_then_decrypt.gif" alt="Clone And Decrypt" style="width:720px">

Make sure to only clone from bare repositories (see [git-clone(1)](http://git-scm.com/docs/git-clone) for how to create a bare repository from an existing one). Otherwise the clone will fail.

Features
========
- Clone an existing pass repository (ssh-key and user/pass support)
- List the passwords
- Handle the directories as categories
- Decrypt the password files (first line is the password, the rest is extra data)
- Add a new password to the current category (or no category if added at the root)
- Pull and Push changes to the remote repository
- Ability to change remote repository info

Libraries
=========
This project uses three libraries:

- [OpenKeyChain](https://github.com/open-keychain/open-keychain) for encryption and decryption of passwords.
    To download the library, run the following commands at the root of the project

        git submodule init
        git submodule update


- [JGit](http://www.eclipse.org/jgit/) a pretty good git lib
- [Apache's FileUtils](https://commons.apache.org/proper/commons-io/) for files manipulations

TODOs
=====
- Create a new category
- Multi-select (for password deletion)
- Multiple password stores (multiple git repositories).
- More UI enhancements
- Clean-up the hard-coded strings

Needed
======
- Icons: the current ones are CC, but would be great to have our own icons
- UI enhancements: any UI changes or suggestions are welcome


[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/zeapo/android-password-store/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
some refactoring with nicer icons... 2014-08-06 19:35:03 +00:00			`PwdStore`
			`========`

Update README.md with note to use bare repos only Also update link to official pass website. 2014-11-01 22:05:48 +00:00			`This application tries to be 100% compatible with [pass](http://www.passwordstore.org/)`
some refactoring with nicer icons... 2014-08-06 19:35:03 +00:00
added links to irc and the community 2014-10-29 22:34:16 +00:00			`You can install the application from:`

			`- [F-Droid](https://f-droid.org/repository/browse/?fdid=com.zeapo.pwdstore) (the prefered way)`
			`- [Play Store](https://play.google.com/store/apps/details?id=com.zeapo.pwdstore) (always lags behind)`
			- Using the apk file found at `app/app-release.apk` or build everything from source (always updated before Play Store, but usually after F-Droid)

			`Community`
			`=========`

			`A few ways to get in touch:`

			`- [Github issues](https://github.com/zeapo/Android-Password-Store/issues), use it if you have a bug report, you do not understand how somehting works or feature request`
			`- IRC : on irc://chat.freenode.net/Android-Password-Store (that means channel #Android-Password-Store on freenode), some of us hangout there`
			`- [reddit](https://www.reddit.com/r/androidpwd), want to discuss something and it's midnight, no one on irc and you really want to write more than a couple of lines? reddit is your way!`
Added a gif to explain how it works. And the APKs Fix #3 2014-09-13 09:36:02 +00:00
			`How-To`
			`======`
			`Note: This section is work in progress`

			`Clone using SSH-key, then decrypt a password`
			`--------------------------------------------`
smaller image size 2014-09-13 09:56:59 +00:00
			`<img src="tutorial_clone_ssh_then_decrypt.gif" alt="Clone And Decrypt" style="width:720px">`
Small readme update (and configs) 2014-08-15 20:57:07 +00:00
Update README.md with note to use bare repos only Also update link to official pass website. 2014-11-01 22:05:48 +00:00			`Make sure to only clone from bare repositories (see [git-clone(1)](http://git-scm.com/docs/git-clone) for how to create a bare repository from an existing one). Otherwise the clone will fail.`

Updated README.md 2014-08-09 00:11:26 +00:00			`Features`
some refactoring with nicer icons... 2014-08-06 19:35:03 +00:00			`========`
major changes (added ssh-key support) 2014-08-23 19:29:08 +00:00			`- Clone an existing pass repository (ssh-key and user/pass support)`
some refactoring with nicer icons... 2014-08-06 19:35:03 +00:00			`- List the passwords`
			`- Handle the directories as categories`
			`- Decrypt the password files (first line is the password, the rest is extra data)`
			`- Add a new password to the current category (or no category if added at the root)`
Updated README.md 2014-08-09 00:11:26 +00:00			`- Pull and Push changes to the remote repository`
			`- Ability to change remote repository info`
some refactoring with nicer icons... 2014-08-06 19:35:03 +00:00
			`Libraries`
			`=========`
			`This project uses three libraries:`
corrected readme 2014-08-06 22:07:42 +00:00
Small readme update (and configs) 2014-08-15 20:57:07 +00:00			`- [OpenKeyChain](https://github.com/open-keychain/open-keychain) for encryption and decryption of passwords.`
Added submodule for checking out openpgp-api-lib 2014-08-15 20:47:28 +00:00			`To download the library, run the following commands at the root of the project`

			`git submodule init`
			`git submodule update`


Added link to F-Droid in README.md 2014-09-21 16:29:54 +00:00			`- [JGit](http://www.eclipse.org/jgit/) a pretty good git lib`
corrected readme 2014-08-06 22:07:42 +00:00			`- [Apache's FileUtils](https://commons.apache.org/proper/commons-io/) for files manipulations`
some refactoring with nicer icons... 2014-08-06 19:35:03 +00:00
			`TODOs`
			`=====`
added account name settings and made it mandatory for encryption 2014-08-06 23:38:16 +00:00			`- Create a new category`
some refactoring with nicer icons... 2014-08-06 19:35:03 +00:00			`- Multi-select (for password deletion)`
Added link to F-Droid in README.md 2014-09-21 16:29:54 +00:00			`- Multiple password stores (multiple git repositories).`
some refactoring with nicer icons... 2014-08-06 19:35:03 +00:00			`- More UI enhancements`
added account name settings and made it mandatory for encryption 2014-08-06 23:38:16 +00:00			`- Clean-up the hard-coded strings`
some refactoring with nicer icons... 2014-08-06 19:35:03 +00:00
			`Needed`
			`======`
			`- Icons: the current ones are CC, but would be great to have our own icons`
			`- UI enhancements: any UI changes or suggestions are welcome`





Add a Bitdeli badge to README 2014-10-29 22:02:32 +00:00

			`[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/zeapo/android-password-store/trend.png)](https://bitdeli.com/free "Bitdeli Badge")`