Some README updates (#746)

This commit is contained in:
Harsh Shandilya 2020-04-26 18:22:01 +05:30 committed by GitHub
parent 8cada17bcb
commit 6350682bd1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -26,25 +26,7 @@ Pull requests are more than welcome (see [TODO](https://github.com/android-passw
## How-To ## How-To
See the [wiki](https://github.com/android-password-store/Android-Password-Store/wiki/First-time-setup) for a newer written version of the following gif walkthrough See the [wiki](https://github.com/android-password-store/Android-Password-Store/wiki/First-time-setup) for FAQs and other thorough documentation.
## FAQ
**Q:** What kind of repository can I clone from?
**A:** 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.
**Q:** I get a "Permission Denied" error when trying to import my ssh-key, why?
**A:** ssh-key files are usually created with permissions set to `600` , meaning that only the creator of this key has the right to read from it. The application needs a read access, at least temporarily, make the permissions to `644` , import the key, then set them back to `600` .
**Q** I get the error *No encrypted data with known secret key found in stream*
**A** In OpenKeyChain **(under the left drawer) Apps > Password Store > Accounts > (select the account) > Account key** select the key used to encrypt your passwords.
**Q** OpenKeyChain's password prompt doesn't show up when I tap on my passwords
**A** Be sure to disable battery optimisation for OpenKeychain in your device's settings and make sure there is no task killer running.
## Community ## Community
@ -56,14 +38,6 @@ Ways to get in touch:
Interested in helping to translate Password Store? Contribute [here](https://www.transifex.com/android-password-store/android-password-store/)! Interested in helping to translate Password Store? Contribute [here](https://www.transifex.com/android-password-store/android-password-store/)!
## Libraries
Libraries that this project uses:
* [OpenKeyChain](https://github.com/open-keychain/open-keychain) for encryption and decryption of passwords.
* [JGit](http://www.eclipse.org/jgit/) git library.
* [Apache's FileUtils](https://commons.apache.org/proper/commons-io/) for file manipulations.
## Contributors ## Contributors
This project exists thanks to all the people who contribute. Want to contribute? See if you can [find an issue](https://github.com/android-password-store/Android-Password-Store/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) you wanna close, then send a PR! This project exists thanks to all the people who contribute. Want to contribute? See if you can [find an issue](https://github.com/android-password-store/Android-Password-Store/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) you wanna close, then send a PR!