Rewrite README some more.

This commit is contained in:
Frank Osterfeld 2012-05-09 19:47:50 +02:00
parent 617449da0d
commit bab1673bb5
1 changed files with 3 additions and 4 deletions

View File

@ -1,10 +1,7 @@
QtKeychain
==========
QtKeychain is a Qt API to securely write and read passwords. The passwords are stored in the platform's keychain service.
In case there is no such service available, QtKeychain will report an error. It will not store any data unencrypted.
Currently, the following platforms are supported:
QtKeychain is a Qt API to store passwords and other secret data securely. How the data is stored depends on the platform:
* **Mac OS X:** Passwords are stored in the OS X Keychain.
@ -14,4 +11,6 @@ Support for the GNOME Keyring via freedesktop.org's
* **Windows:** Windows does not provide a service for secure storage. QtKeychain uses the Windows API function [CryptProtectData](http://msdn.microsoft.com/en-us/library/windows/desktop/aa380261%28v=vs.85%29.aspx "CryptProtectData function") to encrypt the password with the user's logon credentials. The encrypted data is then persisted via QSettings.
In unsupported environments QtKeychain will report an error. It will never store any data unencrypted.
**License:** QtKeychain is available under the [Modified BSD License](http://www.gnu.org/licenses/license-list.html#ModifiedBSD). See the file COPYING for details.