[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    [ksecrets] /: Adjusting initial documentation
From:       Valentin Rusu <kde () rusu ! info>
Date:       2015-08-02 15:12:38
Message-ID: E1ZLuwI-0005ye-Dv () scm ! kde ! org
[Download RAW message or body]

Git commit ff7f3a5bd1528c0a9141c93c044d27eb8bd99154 by Valentin Rusu.
Committed on 02/08/2015 at 09:23.
Pushed by vrusu into branch 'master'.

Adjusting initial documentation

M  +23   -1    README.md
M  +1    -1    metainfo.yaml

http://commits.kde.org/ksecrets/ff7f3a5bd1528c0a9141c93c044d27eb8bd99154

diff --git a/README.md b/README.md
index 47de064..667b084 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,28 @@
 # KDE Secrets Service
 =

+This framework contains all the necessary tools needed to securely store a=
nd handle application secrets.
+
 ## Introduction
 =

-This framework contains all the necessary tools needed to securely store a=
nd handle application secrets.
+KDE applications use this framework to securely store and handle appliction
+secrets. The storage could be a KDE specific one, or some other storage th=
at
+complies to the freedesktop Secret Service specification available here.
+
+http://standards.freedesktop.org/secret-service/
+
+The Free Desktop draft would also instruct you how to configure the storage
+backend in order to activate the one you prefere - ksecrets or some other
+storage like gnome-keyring.
+
+This documentation only covers the KDE specific code.
+
+The main components of the KSecrets Service are:
+
+* pam_ksecrets
+
+* KF5::Secrets framework
+
+* ksecrets
+
+TODO - write more documentation here. However, right now I'd like to get i=
t working ;-)
 =

diff --git a/metainfo.yaml b/metainfo.yaml
index f783fa9..30731a1 100644
--- a/metainfo.yaml
+++ b/metainfo.yaml
@@ -1,4 +1,4 @@
-maintainer: Valentin Rusu
+maintainer: vrusu
 description: Secure and unified container for user passwords
 tier: 3
 type: solution

[prev in list] [next in list] [prev in thread] [next in thread]