Skip to content
This repository was archived by the owner on Oct 15, 2024. It is now read-only.

Commit 9c932f1

Browse files
committed
update README
* Moved sections of the README to the wiki page. * Removed old video walkthrough (could re-record with most recent version of the app). * Re-ordered sections. * Fixed typos.
1 parent e1dfbd0 commit 9c932f1

File tree

2 files changed

+19
-70
lines changed

2 files changed

+19
-70
lines changed

README.md

Lines changed: 19 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
PwdStore
1+
Password Store
22
========
3-
[![IRC](irc_badge.png)](https://webchat.freenode.net/?channels=%23Android-Password-Store&uio=d4)
4-
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/zeapo/android-password-store?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
53
[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Android--Password--Store-blue.svg?style=flat)](https://android-arsenal.com/details/1/1208)
64
[![Build Status](https://travis-ci.org/zeapo/Android-Password-Store.svg?branch=travis)](https://travis-ci.org/zeapo/Android-Password-Store)
75
[![Backers on Open Collective](https://opencollective.com/Android-Password-Store/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/Android-Password-Store/sponsors/badge.svg)](#sponsors)
@@ -16,7 +14,19 @@ You can install the application from:
1614
- [F-Droid](https://f-droid.org/repository/browse/?fdid=com.zeapo.pwdstore) (the prefered way)
1715
- [Play Store](https://play.google.com/store/apps/details?id=com.zeapo.pwdstore) (always lags behind)
1816

19-
Pull requests are more than welcome (see [TODO](#todo)).
17+
Pull requests are more than welcome (see [TODO](https://github.com/zeapo/Android-Password-Store/projects/1#column-228844)).
18+
19+
20+
Features
21+
========
22+
- Clone an existing pass repository (ssh-key and user/pass support)
23+
- List the passwords
24+
- Handle the directories as categories
25+
- Decrypt the password files (first line is the password, the rest is extra data)
26+
- Add a new password to the current category (or no category if added at the root)
27+
- Pull and Push changes to the remote repository
28+
- Ability to change remote repository info
29+
2030

2131
How-To
2232
======
@@ -35,79 +45,18 @@ FAQ
3545
Community
3646
=========
3747

38-
A few ways to get in touch:
39-
40-
- [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
41-
- [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!
42-
43-
44-
TODO
45-
=====
46-
- ~~Implement a keyboard to replace the copy/paste and avoid clipboard hijicking (see [#50](https://github.com/zeapo/Android-Password-Store/issues/50))~~ (Autofill does the job)
47-
- Create a new category
48-
- Multiple password stores (multiple git repositories).
49-
- Solve issues labeld as *enhancement* (see [enhancement issues](https://github.com/zeapo/Android-Password-Store/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement))
50-
51-
52-
Generate a ssh key for your git repo
53-
--------------------------------------------
54-
### From the application
55-
- Go to **settings** > **Generate SSH key pair**
56-
- Select the key size (length)
57-
- Set the passphrase (optional) and a comment (optional)
58-
- Press **Generate**
59-
- Press **Copy** to copy the public key and add it to your ssh server
48+
Ways to get in touch:
6049

61-
### From a terminal
62-
- Generate the private and public key
63-
```
64-
ssh-keygen -C droid_phone -b 2048 -t rsa -f /tmp/id_rsa_droid
65-
```
66-
- Copy the public key `/tmp/id_rsa_droid.pub` on your ssh server and add in to the `~/.ssh/authorized_keys` file
67-
```
68-
cat id_rsa_droid.pub >> ~/.ssh/authorized_keys
69-
```
70-
- Copy the private key `/tmp/id_rsa_droid`to your phone and import it in your Android-Password_Store app through the settings
50+
- [Github issues](https://github.com/zeapo/Android-Password-Store/issues), use it if you have a bug report, you do not understand how something works or you want to submit a feature request.
7151

72-
Export your gpg private key
73-
--------------------------------------------
74-
- Get your pass script gpg id(s) ie: `cat ~/.password-store/.gpg-id`
75-
- You can also get a full ids list using `gpg -k`
76-
- Export your private key with
77-
```
78-
gpg --export-secret-key [the_id] > keys.asc
79-
```
80-
- Import it in OpenKeychain
81-
82-
Clone using SSH-key, then decrypt a password
83-
--------------------------------------------
84-
85-
<img src="tutorial_clone_ssh_then_decrypt.gif" alt="Clone And Decrypt" width="320">
86-
87-
88-
Features
89-
========
90-
- Clone an existing pass repository (ssh-key and user/pass support)
91-
- List the passwords
92-
- Handle the directories as categories
93-
- Decrypt the password files (first line is the password, the rest is extra data)
94-
- Add a new password to the current category (or no category if added at the root)
95-
- Pull and Push changes to the remote repository
96-
- Ability to change remote repository info
9752

9853
Libraries
9954
=========
100-
This project uses three libraries:
55+
Libraries that this project uses:
10156

10257
- [OpenKeyChain](https://github.com/open-keychain/open-keychain) for encryption and decryption of passwords.
103-
To download the library, run the following commands at the root of the project
104-
105-
git submodule init
106-
git submodule update
107-
108-
109-
- [JGit](http://www.eclipse.org/jgit/) a pretty good git lib
110-
- [Apache's FileUtils](https://commons.apache.org/proper/commons-io/) for files manipulations
58+
- [JGit](http://www.eclipse.org/jgit/) git library.
59+
- [Apache's FileUtils](https://commons.apache.org/proper/commons-io/) for file manipulations.
11160

11261
## Contributors
11362

tutorial_clone_ssh_then_decrypt.gif

-2.23 MB
Binary file not shown.

0 commit comments

Comments
 (0)