summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHussein Mohammed <zidhussein@gmail.com>2018-09-28 13:52:27 +0100
committerHussein Mohammed <zidhussein@gmail.com>2018-09-28 13:52:27 +0100
commit9c932f1a10c31cd71206d741c102cc2beb576fa9 (patch)
treebe6d1f9408972fafa4d984490e52248a49ff2ae3 /README.md
parente1dfbd0c99bae9ed599d1826d8292e06410dd587 (diff)
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.
Diffstat (limited to 'README.md')
-rw-r--r--README.md89
1 files changed, 19 insertions, 70 deletions
diff --git a/README.md b/README.md
index 92019196..256cf74f 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,5 @@
-PwdStore
+Password Store
========
-[![IRC](irc_badge.png)](https://webchat.freenode.net/?channels=%23Android-Password-Store&uio=d4)
-[![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)
[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Android--Password--Store-blue.svg?style=flat)](https://android-arsenal.com/details/1/1208)
[![Build Status](https://travis-ci.org/zeapo/Android-Password-Store.svg?branch=travis)](https://travis-ci.org/zeapo/Android-Password-Store)
[![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:
- [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)
-Pull requests are more than welcome (see [TODO](#todo)).
+Pull requests are more than welcome (see [TODO](https://github.com/zeapo/Android-Password-Store/projects/1#column-228844)).
+
+
+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
+
How-To
======
@@ -35,79 +45,18 @@ FAQ
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
-- [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!
-
-
-TODO
-=====
-- ~~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)
-- Create a new category
-- Multiple password stores (multiple git repositories).
-- Solve issues labeld as *enhancement* (see [enhancement issues](https://github.com/zeapo/Android-Password-Store/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement))
-
-
-Generate a ssh key for your git repo
---------------------------------------------
-### From the application
-- Go to **settings** > **Generate SSH key pair**
-- Select the key size (length)
-- Set the passphrase (optional) and a comment (optional)
-- Press **Generate**
-- Press **Copy** to copy the public key and add it to your ssh server
+Ways to get in touch:
-### From a terminal
-- Generate the private and public key
-```
-ssh-keygen -C droid_phone -b 2048 -t rsa -f /tmp/id_rsa_droid
-```
-- Copy the public key `/tmp/id_rsa_droid.pub` on your ssh server and add in to the `~/.ssh/authorized_keys` file
-```
-cat id_rsa_droid.pub >> ~/.ssh/authorized_keys
-```
-- Copy the private key `/tmp/id_rsa_droid`to your phone and import it in your Android-Password_Store app through the settings
+- [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.
-Export your gpg private key
---------------------------------------------
-- Get your pass script gpg id(s) ie: `cat ~/.password-store/.gpg-id`
-- You can also get a full ids list using `gpg -k`
-- Export your private key with
-```
-gpg --export-secret-key [the_id] > keys.asc
-```
-- Import it in OpenKeychain
-
-Clone using SSH-key, then decrypt a password
---------------------------------------------
-
-<img src="tutorial_clone_ssh_then_decrypt.gif" alt="Clone And Decrypt" width="320">
-
-
-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:
+Libraries that this project uses:
- [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
+- [JGit](http://www.eclipse.org/jgit/) git library.
+- [Apache's FileUtils](https://commons.apache.org/proper/commons-io/) for file manipulations.
## Contributors